mirror of
https://github.com/qgis/QGIS.git
synced 2025-03-12 00:02:25 -04:00
cdd23e663e
a toolbar in the map item properties panel This moves the - refresh preview - set to map canvas extent - view extent in map canvas buttons from being oversized push buttons within the item properties panel up to a new toolbar at the top of this panel. Apart from looking better, it means these important actions are always visible regardless of the scroll position of the item properties panel itself. Additionally, it makes it possible to add MORE actions here without overloading the UI (e.g. "set canvas extent to item extent") TODO: better icons
207 lines
5.8 KiB
Plaintext
207 lines
5.8 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
|
|
|
|
An object for property widgets for layout items. All layout config type widgets should contain
|
|
this object.
|
|
|
|
If you are creating a new QgsLayoutItem configuration widget, you should instead
|
|
inherit from QgsLayoutItemBaseWidget (rather then directly working with 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
|
|
|
|
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
|
|
|
|
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
|
|
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
|
|
|
|
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 *
|
|
************************************************************************/
|