mirror of
https://github.com/qgis/QGIS.git
synced 2025-03-10 00:13:55 -04:00
49d56f6c19
Allows for creation of tables with contents manually entered by users (i.e. spreadsheet style), so that users can create completely custom tables. Supports control custom cell contents, foreground and background colors.
304 lines
8.4 KiB
Plaintext
304 lines
8.4 KiB
Plaintext
/************************************************************************
|
|
* 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.
|
|
|
|
A companion class, QgsLayoutItemAbstractGuiMetadata, handles the
|
|
GUI behavior of QgsLayoutItems.
|
|
|
|
.. note::
|
|
|
|
In C++ you can use QgsLayoutItemMetadata convenience class.
|
|
|
|
.. versionadded:: 3.0
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgslayoutitemregistry.h"
|
|
%End
|
|
public:
|
|
|
|
QgsLayoutItemAbstractMetadata( int type, const QString &visibleName, const QString &visiblePluralName = QString() );
|
|
%Docstring
|
|
Constructor for QgsLayoutItemAbstractMetadata with the specified class ``type``
|
|
and ``visibleName``.
|
|
|
|
The optional ``visiblePluralName`` argument can be used to specify a plural variant of the item type.
|
|
%End
|
|
|
|
virtual ~QgsLayoutItemAbstractMetadata();
|
|
|
|
int type() const;
|
|
%Docstring
|
|
Returns the unique item type code for the layout item class.
|
|
%End
|
|
|
|
QString visibleName() const;
|
|
%Docstring
|
|
Returns a translated, user visible name for the layout item class.
|
|
|
|
.. seealso:: :py:func:`visiblePluralName`
|
|
%End
|
|
|
|
QString visiblePluralName() const;
|
|
%Docstring
|
|
Returns a translated, user visible name for plurals of the layout item class (e.g. "Labels" for a "Label" item).
|
|
|
|
.. versionadded:: 3.10
|
|
%End
|
|
|
|
virtual QgsLayoutItem *createItem( QgsLayout *layout ) = 0 /Factory/;
|
|
%Docstring
|
|
Creates a layout item of this class for a specified ``layout``.
|
|
%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 QgsLayoutMultiFrameAbstractMetadata
|
|
{
|
|
%Docstring
|
|
Stores metadata about one layout multiframe class.
|
|
|
|
A companion class, :py:class:`QgsLayoutMultiFrameAbstractGuiMetadata`, handles the
|
|
GUI behavior of :py:class:`QgsLayoutMultiFrames`.
|
|
|
|
.. note::
|
|
|
|
In C++ you can use QgsLayoutMultiFrameMetadata convenience class.
|
|
|
|
.. versionadded:: 3.0
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgslayoutitemregistry.h"
|
|
%End
|
|
public:
|
|
|
|
QgsLayoutMultiFrameAbstractMetadata( int type, const QString &visibleName );
|
|
%Docstring
|
|
Constructor for QgsLayoutMultiFrameAbstractMetadata with the specified class ``type``
|
|
and ``visibleName``.
|
|
%End
|
|
|
|
virtual ~QgsLayoutMultiFrameAbstractMetadata();
|
|
|
|
int type() const;
|
|
%Docstring
|
|
Returns the unique item type code for the layout multiframe class.
|
|
%End
|
|
|
|
virtual QIcon icon() const;
|
|
%Docstring
|
|
Returns an icon representing the layout multiframe type.
|
|
%End
|
|
|
|
QString visibleName() const;
|
|
%Docstring
|
|
Returns a translated, user visible name for the layout multiframe class.
|
|
%End
|
|
|
|
virtual QgsLayoutMultiFrame *createMultiFrame( QgsLayout *layout ) = 0 /Factory/;
|
|
%Docstring
|
|
Creates a layout multiframe of this class for a specified ``layout``.
|
|
%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
|
|
:py:func:`QgsApplication.layoutItemRegistry()`
|
|
|
|
A companion class, :py:class:`QgsLayoutItemGuiRegistry`, handles the GUI behavior
|
|
of layout items.
|
|
|
|
.. versionadded:: 3.0
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgslayoutitemregistry.h"
|
|
%End
|
|
public:
|
|
|
|
enum ItemType
|
|
{
|
|
LayoutItem,
|
|
LayoutGroup,
|
|
|
|
// known item types
|
|
|
|
// WARNING!!!! SIP CASTING OF QgsLayoutItem and QgsLayoutMultiFrame DEPENDS on these
|
|
// values, and must be updated if any additional types are added
|
|
|
|
LayoutPage,
|
|
LayoutMap,
|
|
LayoutPicture,
|
|
LayoutLabel,
|
|
LayoutLegend,
|
|
LayoutShape,
|
|
LayoutPolygon,
|
|
LayoutPolyline,
|
|
LayoutScaleBar,
|
|
LayoutFrame,
|
|
|
|
// known multi-frame types
|
|
|
|
// WARNING!!!! SIP CASTING OF QgsLayoutItem and QgsLayoutMultiFrame DEPENDS on these
|
|
// values, and must be updated if any additional types are added
|
|
|
|
LayoutHtml,
|
|
LayoutAttributeTable,
|
|
LayoutTextTable,
|
|
|
|
Layout3DMap,
|
|
|
|
LayoutManualTable,
|
|
|
|
// item types provided by plugins
|
|
PluginItem,
|
|
};
|
|
|
|
QgsLayoutItemRegistry( QObject *parent = 0 );
|
|
%Docstring
|
|
Creates a new empty item registry.
|
|
|
|
QgsLayoutItemRegistry is not usually directly created, but rather accessed through
|
|
:py:func:`QgsApplication.layoutItemRegistry()`
|
|
|
|
.. seealso:: :py:func:`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``.
|
|
%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.
|
|
|
|
.. seealso:: :py:func:`multiFrameMetadata`
|
|
%End
|
|
|
|
QgsLayoutMultiFrameAbstractMetadata *multiFrameMetadata( int type ) const;
|
|
%Docstring
|
|
Returns the metadata for the specified multiframe ``type``. Returns ``None`` if
|
|
a corresponding type was not found in the registry.
|
|
|
|
.. seealso:: :py:func:`itemMetadata`
|
|
%End
|
|
|
|
bool addLayoutItemType( QgsLayoutItemAbstractMetadata *metadata /Transfer/ );
|
|
%Docstring
|
|
Registers a new layout item type. Takes ownership of the metadata instance.
|
|
|
|
.. seealso:: :py:func:`addLayoutMultiFrameType`
|
|
%End
|
|
|
|
bool addLayoutMultiFrameType( QgsLayoutMultiFrameAbstractMetadata *metadata /Transfer/ );
|
|
%Docstring
|
|
Registers a new layout multiframe type. Takes ownership of the metadata instance.
|
|
|
|
.. seealso:: :py:func:`addLayoutItemType`
|
|
%End
|
|
|
|
QgsLayoutItem *createItem( int type, QgsLayout *layout ) const /Factory/;
|
|
%Docstring
|
|
Creates a new instance of a layout item given the item ``type``, and target ``layout``.
|
|
|
|
.. seealso:: :py:func:`createMultiFrame`
|
|
%End
|
|
|
|
QgsLayoutMultiFrame *createMultiFrame( int type, QgsLayout *layout ) const /Factory/;
|
|
%Docstring
|
|
Creates a new instance of a layout multiframe given the multiframe ``type``, and target ``layout``.
|
|
|
|
.. seealso:: :py:func:`createItem`
|
|
%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.
|
|
%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
|
|
|
|
void multiFrameTypeAdded( int type, const QString &name );
|
|
%Docstring
|
|
Emitted whenever a new multiframe 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 *
|
|
************************************************************************/
|