mirror of
https://github.com/qgis/QGIS.git
synced 2025-11-04 00:04:25 -05:00
c6008b7ee1
reverting 3fb0f66 (followup #45348) Using --no-public-is-protected (default on Windows) also works on Linux and fixes #45331 too
228 lines
6.4 KiB
Plaintext
228 lines
6.4 KiB
Plaintext
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/gui/layout/qgslayoutitemwidget.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
************************************************************************/
|
|
|
|
|
|
|
|
|
|
|
|
class QgsLayoutConfigObject: QObject
|
|
{
|
|
%Docstring(signature="appended")
|
|
|
|
An object for property widgets for layout items. All layout config type widgets should contain
|
|
this object.
|
|
|
|
If you are creating a new :py:class:`QgsLayoutItem` configuration widget, you should instead
|
|
inherit from :py:class:`QgsLayoutItemBaseWidget` (rather then directly working with :py:class:`QgsLayoutConfigObject`).
|
|
|
|
.. versionadded:: 3.0
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgslayoutitemwidget.h"
|
|
%End
|
|
public:
|
|
|
|
QgsLayoutConfigObject( QWidget *parent /TransferThis/, QgsLayoutObject *layoutObject );
|
|
%Docstring
|
|
Constructor for QgsLayoutConfigObject, linked with the specified ``layoutObject``.
|
|
%End
|
|
|
|
void initializeDataDefinedButton( QgsPropertyOverrideButton *button, QgsLayoutObject::DataDefinedProperty key );
|
|
%Docstring
|
|
Registers a data defined ``button``, setting up its initial value, connections and description.
|
|
The corresponding property ``key`` must be specified.
|
|
%End
|
|
|
|
void updateDataDefinedButton( QgsPropertyOverrideButton *button );
|
|
%Docstring
|
|
Updates a data defined button to reflect the item's current properties.
|
|
%End
|
|
|
|
QgsVectorLayer *coverageLayer() const;
|
|
%Docstring
|
|
Returns the current layout context coverage layer (if set).
|
|
%End
|
|
|
|
QgsLayoutAtlas *layoutAtlas() const;
|
|
%Docstring
|
|
Returns the atlas for the layout, if available
|
|
%End
|
|
|
|
|
|
};
|
|
|
|
class QgsLayoutItemBaseWidget: QgsPanelWidget
|
|
{
|
|
%Docstring(signature="appended")
|
|
|
|
A base class for property widgets for layout items. All layout item widgets should inherit from
|
|
this base class.
|
|
|
|
.. versionadded:: 3.0
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgslayoutitemwidget.h"
|
|
%End
|
|
public:
|
|
|
|
QgsLayoutItemBaseWidget( QWidget *parent /TransferThis/, QgsLayoutObject *layoutObject );
|
|
%Docstring
|
|
Constructor for QgsLayoutItemBaseWidget, linked with the specified ``layoutObject``.
|
|
%End
|
|
|
|
QgsLayoutObject *layoutObject();
|
|
%Docstring
|
|
Returns the layout object associated with this widget.
|
|
%End
|
|
|
|
bool setItem( QgsLayoutItem *item );
|
|
%Docstring
|
|
Sets the current ``item`` to show in the widget. If ``True`` is returned, ``item``
|
|
was an acceptable type for display in this widget and the widget has been
|
|
updated to match ``item``'s properties.
|
|
|
|
If ``False`` is returned, then the widget could not be successfully updated
|
|
to show the properties of ``item``.
|
|
%End
|
|
|
|
virtual void setReportTypeString( const QString &string );
|
|
%Docstring
|
|
Sets the ``string`` to use to describe the current report type (e.g.
|
|
"atlas" or "report").
|
|
Subclasses which display this text to users should override this
|
|
and update their widget labels accordingly.
|
|
%End
|
|
|
|
virtual void setDesignerInterface( QgsLayoutDesignerInterface *iface );
|
|
%Docstring
|
|
Sets the the layout designer interface in which the widget is
|
|
being shown.
|
|
|
|
.. versionadded:: 3.6
|
|
%End
|
|
|
|
virtual void setMasterLayout( QgsMasterLayoutInterface *masterLayout );
|
|
%Docstring
|
|
Sets the master layout associated with the item.
|
|
|
|
.. versionadded:: 3.10
|
|
%End
|
|
|
|
protected:
|
|
|
|
void registerDataDefinedButton( QgsPropertyOverrideButton *button, QgsLayoutObject::DataDefinedProperty property );
|
|
%Docstring
|
|
Registers a data defined ``button``, setting up its initial value, connections and description.
|
|
The corresponding property ``key`` must be specified.
|
|
%End
|
|
|
|
void updateDataDefinedButton( QgsPropertyOverrideButton *button );
|
|
%Docstring
|
|
Updates a previously registered data defined button to reflect the item's current properties.
|
|
%End
|
|
|
|
QgsVectorLayer *coverageLayer() const;
|
|
%Docstring
|
|
Returns the current layout context coverage layer (if set).
|
|
%End
|
|
|
|
virtual bool setNewItem( QgsLayoutItem *item );
|
|
%Docstring
|
|
Attempts to update the widget to show the properties
|
|
for the specified ``item``.
|
|
|
|
Subclasses can override this if they support changing items in place.
|
|
|
|
Implementations must return ``True`` if the item was accepted and
|
|
the widget was updated.
|
|
%End
|
|
|
|
QgsLayoutAtlas *layoutAtlas() const;
|
|
%Docstring
|
|
Returns the atlas for the layout (if available)
|
|
%End
|
|
|
|
};
|
|
|
|
|
|
class QgsLayoutItemPropertiesWidget: QWidget
|
|
{
|
|
%Docstring(signature="appended")
|
|
A widget for controlling the common properties of layout items (e.g. position and size, background, stroke, frame).
|
|
This widget can be embedded into other layout item widgets.
|
|
|
|
.. versionadded:: 3.0
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgslayoutitemwidget.h"
|
|
%End
|
|
public:
|
|
|
|
QgsLayoutItemPropertiesWidget( QWidget *parent, QgsLayoutItem *item );
|
|
%Docstring
|
|
Constructs a QgsLayoutItemPropertiesWidget with a ``parent`` and for the given layout ``item``.
|
|
%End
|
|
|
|
QgsLayoutItem::ReferencePoint positionMode() const;
|
|
%Docstring
|
|
Returns the position mode
|
|
%End
|
|
|
|
void showBackgroundGroup( bool showGroup );
|
|
%Docstring
|
|
Determines if the background of the group box shall be shown
|
|
%End
|
|
|
|
void showFrameGroup( bool showGroup );
|
|
%Docstring
|
|
Determines if the frame of the group box shall be shown
|
|
%End
|
|
|
|
void setItem( QgsLayoutItem *item );
|
|
%Docstring
|
|
Sets the layout item
|
|
%End
|
|
|
|
void setMasterLayout( QgsMasterLayoutInterface *masterLayout );
|
|
%Docstring
|
|
Sets the master layout associated with the item.
|
|
|
|
.. versionadded:: 3.10
|
|
%End
|
|
|
|
void updateVariables();
|
|
%Docstring
|
|
Updates the variables widget, refreshing the values of variables shown.
|
|
|
|
.. versionadded:: 3.10
|
|
%End
|
|
|
|
protected slots:
|
|
void initializeDataDefinedButtons();
|
|
%Docstring
|
|
Initializes data defined buttons to current atlas coverage layer
|
|
%End
|
|
void populateDataDefinedButtons();
|
|
%Docstring
|
|
Sets data defined button state to match item
|
|
%End
|
|
|
|
};
|
|
|
|
|
|
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/gui/layout/qgslayoutitemwidget.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
************************************************************************/
|