QGIS/python/core/layout/qgslayoutitemregistry.sip

/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/layout/qgslayoutitemregistry.h                              *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
 ************************************************************************/




class QgsLayoutItemAbstractMetadata
{
%Docstring
 Stores metadata about one layout item class.
.. note::

   In C++ you can use QgsSymbolLayerMetadata convenience class.
.. versionadded:: 3.0
%End

%TypeHeaderCode
#include "qgslayoutitemregistry.h"
%End
  public:

    QgsLayoutItemAbstractMetadata( int type, const QString &visibleName );
%Docstring
 Constructor for QgsLayoutItemAbstractMetadata with the specified class ``type``
 and ``visibleName``.
%End

    virtual ~QgsLayoutItemAbstractMetadata();

    int type() const;
%Docstring
 Returns the unique item type code for the layout item class.
 :rtype: int
%End

    virtual QIcon icon() const;
%Docstring
 Returns an icon representing the layout item type.
 :rtype: QIcon
%End

    QString visibleName() const;
%Docstring
 Returns a translated, user visible name for the layout item class.
 :rtype: str
%End

    virtual QgsLayoutItem *createItem( QgsLayout *layout, const QVariantMap &properties ) = 0 /Factory/;
%Docstring
 Creates a layout item of this class for a specified ``layout``, given the map of ``properties``.
 :rtype: QgsLayoutItem
%End

    virtual QWidget *createItemWidget() /Factory/;
%Docstring
 Creates a configuration widget for layout items of this type. Can return None if no configuration GUI is required.
 :rtype: QWidget
%End


    virtual void resolvePaths( QVariantMap &properties, const QgsPathResolver &pathResolver, bool saving );
%Docstring
 Resolve paths in the item's ``properties`` (if there are any paths).
 When ``saving`` is true, paths are converted from absolute to relative,
 when ``saving`` is false, paths are converted from relative to absolute.
 This ensures that paths in project files can be relative, but in item
 instances the paths are always absolute.
%End

};








class QgsLayoutItemRegistry : QObject
{
%Docstring
 Registry of available layout item types.

 QgsLayoutItemRegistry is not usually directly created, but rather accessed through
 QgsApplication.layoutItemRegistry().

.. versionadded:: 3.0
%End

%TypeHeaderCode
#include "qgslayoutitemregistry.h"
%End
  public:

    enum ItemType
    {
      LayoutItem,

      // known
      LayoutPage,

      // item
      PluginItem,
    };

    QgsLayoutItemRegistry( QObject *parent = 0 );
%Docstring
 Creates a new empty item registry.

 QgsLayoutItemRegistry is not usually directly created, but rather accessed through
 QgsApplication.layoutItemRegistry().

.. seealso:: populate()
%End

    ~QgsLayoutItemRegistry();

    bool populate();
%Docstring
 Populates the registry with standard item types. If called on a non-empty registry
 then this will have no effect and will return false.
 :rtype: bool
%End


    QgsLayoutItemAbstractMetadata *itemMetadata( int type ) const;
%Docstring
 Returns the metadata for the specified item ``type``. Returns None if
 a corresponding type was not found in the registry.
 :rtype: QgsLayoutItemAbstractMetadata
%End

    bool addLayoutItemType( QgsLayoutItemAbstractMetadata *metadata /Transfer/ );
%Docstring
 Registers a new layout item type. Takes ownership of the metadata instance.
 :rtype: bool
%End

    QgsLayoutItem *createItem( int type, QgsLayout *layout, const QVariantMap &properties = QVariantMap() ) const /Factory/;
%Docstring
 Creates a new instance of a layout item given the item ``type``, target ``layout`` and ``properties``.
 :rtype: QgsLayoutItem
%End

    QWidget *createItemWidget( int type ) const /Factory/;
%Docstring
 Creates a new instance of a layout item configuration widget for the specified item ``type``.
 :rtype: QWidget
%End


    void resolvePaths( int type, QVariantMap &properties, const QgsPathResolver &pathResolver, bool saving ) const;
%Docstring
 Resolve paths in properties of a particular symbol layer.
 This normally means converting relative paths to absolute paths when loading
 and converting absolute paths to relative paths when saving.
%End

    QMap< int, QString> itemTypes() const;
%Docstring
 Returns a map of available item types to translated name.
 :rtype: QMap< int, str>
%End

  signals:

    void typeAdded( int type, const QString &name );
%Docstring
 Emitted whenever a new item type is added to the registry, with the specified
 ``type`` and visible ``name``.
%End

  private:
    QgsLayoutItemRegistry( const QgsLayoutItemRegistry &rh );
};





/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/layout/qgslayoutitemregistry.h                              *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
 ************************************************************************/