QGIS/python/gui/auto_generated/effects/qgseffectstackpropertieswidget.sip.in

256 lines
6.2 KiB
Plaintext
Raw Normal View History

2017-06-08 15:37:13 +02:00
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/effects/qgseffectstackpropertieswidget.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
2016-06-13 18:07:39 +10:00
class QgsEffectStackPropertiesWidget : QgsPanelWidget
{
2017-06-08 15:37:13 +02:00
%Docstring
A widget for modifying the properties of a QgsEffectStack, including adding
2017-12-15 10:36:55 -04:00
and reordering effects within the stack.
2017-06-08 15:37:13 +02:00
2017-12-05 20:04:14 -04:00
.. seealso:: :py:class:`QgsEffectStack`
2017-12-15 10:36:55 -04:00
2017-12-05 20:04:14 -04:00
.. seealso:: :py:class:`QgsEffectStackPropertiesDialog`
2017-12-15 10:36:55 -04:00
2017-12-05 20:04:14 -04:00
.. seealso:: :py:class:`QgsEffectStackCompactWidget`
2018-05-28 11:31:08 -04:00
.. versionadded:: 2.9
%End
2017-06-08 15:37:13 +02:00
%TypeHeaderCode
#include "qgseffectstackpropertieswidget.h"
%End
public:
QgsEffectStackPropertiesWidget( QgsEffectStack *stack, QWidget *parent /TransferThis/ = 0 );
2017-06-08 15:37:13 +02:00
%Docstring
2017-12-15 10:36:55 -04:00
QgsEffectStackPropertiesWidget constructor
2017-12-15 21:36:08 -04:00
2017-12-15 10:36:55 -04:00
:param stack: QgsEffectStack to modify in the widget
:param parent: parent widget
2017-06-08 15:37:13 +02:00
%End
~QgsEffectStackPropertiesWidget();
QgsEffectStack *stack();
2017-06-08 15:37:13 +02:00
%Docstring
2017-12-15 10:36:55 -04:00
Returns effect stack attached to the widget
:return: QgsEffectStack modified by the widget
2017-06-08 15:37:13 +02:00
%End
void setPreviewPicture( const QPicture &picture );
2017-06-08 15:37:13 +02:00
%Docstring
2017-12-15 10:36:55 -04:00
Sets the picture to use for effect previews for the dialog
2017-12-15 21:36:08 -04:00
2017-12-15 10:36:55 -04:00
:param picture: preview picture
2017-06-08 15:37:13 +02:00
%End
public slots:
void moveEffectDown();
2017-06-08 15:37:13 +02:00
%Docstring
2017-12-15 10:36:55 -04:00
Moves the currently selected effect down in the stack.
2017-06-08 15:37:13 +02:00
%End
void moveEffectUp();
2017-06-08 15:37:13 +02:00
%Docstring
2017-12-15 10:36:55 -04:00
Moves the currently selected effect up in the stack.
2017-06-08 15:37:13 +02:00
%End
void addEffect();
2017-06-08 15:37:13 +02:00
%Docstring
2017-12-15 10:36:55 -04:00
Adds a new effect to the stack.
2017-06-08 15:37:13 +02:00
%End
void removeEffect();
2017-06-08 15:37:13 +02:00
%Docstring
2017-12-15 10:36:55 -04:00
Removes the currently selected effect from the stack.
2017-06-08 15:37:13 +02:00
%End
void effectChanged();
2017-06-08 15:37:13 +02:00
%Docstring
2017-12-15 10:36:55 -04:00
Updates the widget when the selected effect changes type.
2017-06-08 15:37:13 +02:00
%End
void updatePreview();
2017-06-08 15:37:13 +02:00
%Docstring
2017-12-15 10:36:55 -04:00
Updates the effect preview icon.
2017-06-08 15:37:13 +02:00
%End
void changeEffect( QgsPaintEffect *newEffect );
2017-06-08 15:37:13 +02:00
%Docstring
2017-12-15 10:36:55 -04:00
Updates the effect stack when the currently selected effect changes properties.
2017-12-15 21:36:08 -04:00
2017-12-15 10:36:55 -04:00
:param newEffect: new effect to replace existing effect at selected position within the stack.
2017-06-08 15:37:13 +02:00
%End
protected:
2017-06-08 15:37:13 +02:00
void loadStack();
2017-06-08 15:37:13 +02:00
%Docstring
2017-12-15 10:36:55 -04:00
Refreshes the widget to reflect the current state of the stack.
2017-06-08 15:37:13 +02:00
%End
void loadStack( QgsEffectStack *stack );
2017-06-08 15:37:13 +02:00
%Docstring
2017-12-15 10:36:55 -04:00
Refreshes the widget to reflect the current state of a specified stack.
2017-12-15 21:36:08 -04:00
2017-12-15 10:36:55 -04:00
:param stack: QgsEffectStack for widget
2017-06-08 15:37:13 +02:00
%End
void updateUi();
2017-06-08 15:37:13 +02:00
%Docstring
2017-12-15 10:36:55 -04:00
Enables or disables widgets depending on the selected effect within the stack.
2017-06-08 15:37:13 +02:00
%End
void moveEffectByOffset( int offset );
2017-06-08 15:37:13 +02:00
%Docstring
2017-12-15 10:36:55 -04:00
Moves the currently selected effect within the stack by a specified offset
2017-06-08 15:37:13 +02:00
%End
void setWidget( QWidget *widget );
2017-06-08 15:37:13 +02:00
%Docstring
2017-12-15 10:36:55 -04:00
Sets the effect properties widget
2017-06-08 15:37:13 +02:00
%End
};
2017-06-08 15:37:13 +02:00
class QgsEffectStackPropertiesDialog: QgsDialog
{
2017-06-08 15:37:13 +02:00
%Docstring
A dialog for modifying the properties of a :py:class:`QgsEffectStack`, including adding
2017-12-15 10:36:55 -04:00
and reordering effects within the stack.
2017-06-08 15:37:13 +02:00
2017-12-05 20:04:14 -04:00
.. seealso:: :py:class:`QgsEffectStack`
2017-12-15 10:36:55 -04:00
2017-12-05 20:04:14 -04:00
.. seealso:: :py:class:`QgsEffectStackPropertiesWidget`
2017-12-15 10:36:55 -04:00
2017-12-05 20:04:14 -04:00
.. seealso:: :py:class:`QgsEffectStackCompactWidget`
2018-05-28 11:31:08 -04:00
.. versionadded:: 2.9
%End
2017-06-08 15:37:13 +02:00
%TypeHeaderCode
#include "qgseffectstackpropertieswidget.h"
%End
public:
2017-06-08 15:37:13 +02:00
QgsEffectStackPropertiesDialog( QgsEffectStack *stack, QWidget *parent /TransferThis/ = 0, Qt::WindowFlags f = 0 );
%Docstring
2017-12-15 10:36:55 -04:00
QgsEffectStackPropertiesDialog constructor
2017-12-15 21:36:08 -04:00
2017-12-15 10:36:55 -04:00
:param stack: QgsEffectStack to modify in the dialog
:param parent: parent widget
:param f: window flags
2017-06-08 15:37:13 +02:00
%End
QgsEffectStack *stack();
2017-06-08 15:37:13 +02:00
%Docstring
2017-12-15 10:36:55 -04:00
Returns effect stack attached to the dialog
:return: QgsEffectStack modified by the dialog
2017-06-08 15:37:13 +02:00
%End
void setPreviewPicture( const QPicture &picture );
2017-06-08 15:37:13 +02:00
%Docstring
2017-12-15 10:36:55 -04:00
Sets the picture to use for effect previews for the dialog
2017-12-15 21:36:08 -04:00
2017-12-15 10:36:55 -04:00
:param picture: preview picture
2017-06-08 15:37:13 +02:00
%End
protected:
2015-04-07 14:27:39 +02:00
};
2017-06-08 15:37:13 +02:00
class QgsEffectStackCompactWidget: QgsPanelWidget
{
2017-06-08 15:37:13 +02:00
%Docstring
A small widget consisting of a checkbox for enabling/disabling an effect stack
and a button for opening an effect stack customization dialog.
2017-06-08 15:37:13 +02:00
2017-12-05 20:04:14 -04:00
.. seealso:: :py:class:`QgsEffectStack`
2017-12-15 10:36:55 -04:00
2017-12-05 20:04:14 -04:00
.. seealso:: :py:class:`QgsEffectStackPropertiesWidget`
2017-12-15 10:36:55 -04:00
2017-12-05 20:04:14 -04:00
.. seealso:: :py:class:`QgsEffectStackPropertiesDialog`
2018-05-28 11:31:08 -04:00
.. versionadded:: 2.9
2017-06-08 15:37:13 +02:00
%End
%TypeHeaderCode
2017-06-08 15:37:13 +02:00
#include "qgseffectstackpropertieswidget.h"
%End
public:
QgsEffectStackCompactWidget( QWidget *parent /TransferThis/ = 0, QgsPaintEffect *effect = 0 );
2017-06-08 15:37:13 +02:00
%Docstring
2017-12-15 10:36:55 -04:00
QgsEffectStackCompactWidget constructor
2017-12-15 21:36:08 -04:00
2017-12-15 10:36:55 -04:00
:param parent: parent widget
:param effect: QgsPaintEffect for modification by the widget. If the effect
is not a :py:class:`QgsEffectStack`, it will be automatically converted to an effect
stack consisting of the original effect
2017-06-08 15:37:13 +02:00
%End
~QgsEffectStackCompactWidget();
void setPaintEffect( QgsPaintEffect *effect );
2017-06-08 15:37:13 +02:00
%Docstring
2017-12-15 10:36:55 -04:00
Sets paint effect attached to the widget,
2017-12-15 21:36:08 -04:00
2017-12-15 10:36:55 -04:00
:param effect: QgsPaintEffect for modification by the widget. If the effect
is not a :py:class:`QgsEffectStack`, it will be automatically converted to an effect
stack consisting of the original effect
2017-12-15 10:36:55 -04:00
2017-12-05 20:04:14 -04:00
.. seealso:: :py:func:`paintEffect`
2017-06-08 15:37:13 +02:00
%End
QgsPaintEffect *paintEffect() const;
2017-06-08 15:37:13 +02:00
%Docstring
2017-12-15 10:36:55 -04:00
Returns paint effect attached to the widget
:return: QgsPaintEffect modified by the widget
2017-12-05 20:04:14 -04:00
.. seealso:: :py:func:`setPaintEffect`
2017-06-08 15:37:13 +02:00
%End
void setPreviewPicture( const QPicture &picture );
2017-06-08 15:37:13 +02:00
%Docstring
2017-12-15 10:36:55 -04:00
Sets the picture to use for effect previews for the dialog
2017-12-15 21:36:08 -04:00
2017-12-15 10:36:55 -04:00
:param picture: preview picture
2017-06-08 15:37:13 +02:00
%End
signals:
void changed();
2017-06-08 15:37:13 +02:00
%Docstring
2017-12-15 10:36:55 -04:00
Emitted when the paint effect properties change
2017-06-08 15:37:13 +02:00
%End
};
2017-06-08 15:37:13 +02:00
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/effects/qgseffectstackpropertieswidget.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/