QGIS/python/core/auto_generated/qgsanimatedicon.sip.in
Nyall Dawson c864d22d1f Add "get ..." to doxygen compliance blacklist
Should be "gets ..." for consistent tense, or better yet
"returns ..." for consistency.
2018-05-27 14:05:06 +10:00

98 lines
2.8 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgsanimatedicon.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsAnimatedIcon : QObject
{
%Docstring
Animated icon is keeping an animation running if there are listeners connected to frameChanged
%End
%TypeHeaderCode
#include "qgsanimatedicon.h"
%End
public:
QgsAnimatedIcon( const QString &iconPath = QString(), QObject *parent = 0 );
%Docstring
Create a new animated icon. Optionally, the ``iconPath`` can already be specified.
%End
QString iconPath() const;
%Docstring
Path to a movie, e.g. animated GIF
%End
void setIconPath( const QString &iconPath );
%Docstring
Path to a movie, e.g. animated GIF
%End
QIcon icon() const;
%Docstring
Gets the icons representation in the current frame.
This will need to be called repeatedly, whenever a frameChanged()
signal is emitted.
%End
bool connectFrameChanged( const QObject *receiver, const char *method );
%Docstring
Connect a slot that will be notified repeatedly whenever a frame changes and which should
request the current icon and trigger UI updates.
Connect to the frame changed signal with this method and not directly. This method
makes sure the annimation is started.
.. versionadded:: 3.0
%End
bool disconnectFrameChanged( const QObject *receiver, const char *method );
%Docstring
Convenience function to disconnect the same style that the frame change connection was established.
.. versionadded:: 3.0
%End
int width() const;
%Docstring
The native width of the icon.
.. versionadded:: 3.0
%End
int height() const;
%Docstring
The native height of the icon.
.. versionadded:: 3.0
%End
signals:
void frameChanged();
%Docstring
Emitted when the icon changed. You should use connectFrameChanged instead of connecting
to this signal directly.
Connecting to this signal directly will cause the animation not to be started.
.. seealso:: :py:func:`connectFrameChanged`
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgsanimatedicon.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/