QGIS/python/gui/auto_generated/tableeditor/qgstableeditordialog.sip.in
Nyall Dawson 756cb6f592 [layouts] Improve Manual Table handling of header cells
Instead of hiding this functionality from users, we instead add an explicit
toggle to the Table Designer dialog "Table" menu to hide or show
the header cells in the designer, and re-add the widgets which
allow users to customise the header appearance back into the
item configuration widget.

Whenever a header cell is selected in the table designer, the formatting
widgets are disabled since the item's header configuration widgets
are used to set the background/foreground color and other properties
of these cells instead.
2020-02-14 06:38:38 +10:00

132 lines
3.7 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/tableeditor/qgstableeditordialog.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsTableEditorDialog : QMainWindow
{
%Docstring
A reusable window for editing simple spreadsheet-style tables.
Table content is retrieved and set using the QgsTableContents class. The editor
has support for table foreground and background colors, and numeric formats.
.. versionadded:: 3.12
%End
%TypeHeaderCode
#include "qgstableeditordialog.h"
%End
public:
QgsTableEditorDialog( QWidget *parent = 0 );
%Docstring
Constructor for QgsTableEditorDialog with the specified ``parent`` widget.
%End
void setTableContents( const QgsTableContents &contents );
%Docstring
Sets the ``contents`` to show in the editor widget.
.. seealso:: :py:func:`tableContents`
%End
QgsTableContents tableContents() const;
%Docstring
Returns the current contents of the editor widget table.
.. seealso:: :py:func:`setTableContents`
%End
double tableRowHeight( int row );
%Docstring
Returns the configured row height for the specified ``row``, or 0 if an automatic height
should be used for the row.
.. seealso:: :py:func:`setTableRowHeight`
%End
double tableColumnWidth( int column );
%Docstring
Returns the configured column width for the specified ``column``, or 0 if an automatic width
should be used for the column.
.. seealso:: :py:func:`setTableColumnWidth`
%End
void setTableRowHeight( int row, double height );
%Docstring
Sets the configured row ``height`` for the specified ``row``. Set ``height`` to 0
if an automatic height should be used for the row.
This should be called after a call to setTableContents().
.. seealso:: :py:func:`tableRowHeight`
%End
void setTableColumnWidth( int column, double width );
%Docstring
Sets the configured column ``width`` for the specified ``column``. Set ``width`` to 0
if an automatic width should be used for the column.
This should be called after a call to setTableContents().
.. seealso:: :py:func:`tableColumnWidth`
%End
bool includeTableHeader() const;
%Docstring
Returns ``True`` if the table includes a header row.
.. seealso:: :py:func:`setIncludeTableHeader`
%End
void setIncludeTableHeader( bool included );
%Docstring
Sets whether the table includes a header row.
.. seealso:: :py:func:`includeTableHeader`
%End
QVariantList tableHeaders() const;
%Docstring
Returns the table header values.
.. seealso:: :py:func:`setTableHeaders`
%End
void setTableHeaders( const QVariantList &headers );
%Docstring
Sets the table ``headers``.
.. seealso:: :py:func:`tableHeaders`
%End
signals:
void tableChanged();
%Docstring
Emitted whenever the table contents are changed.
%End
void includeHeaderChanged( bool included );
%Docstring
Emitted whenever the "include table header" setting is changed.
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/tableeditor/qgstableeditordialog.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/