/************************************************************************ * This file has been generated automatically from * * * * src/core/qgsattributeeditorelement.h * * * * Do not edit manually ! Edit header and run scripts/sipify.pl again * ************************************************************************/ class QgsAttributeEditorElement /Abstract/ { %Docstring This is an abstract base class for any elements of a drag and drop form. This can either be a container which will be represented on the screen as a tab widget or ca collapsible group box. Or it can be a field which will then be represented based on the QgsEditorWidget type and configuration. Or it can be a relation and embed the form of several children of another layer. %End %TypeHeaderCode #include "qgsattributeeditorelement.h" %End %ConvertToSubClassCode switch ( sipCpp->type() ) { case QgsAttributeEditorElement::AeTypeContainer: sipType = sipType_QgsAttributeEditorContainer; break; case QgsAttributeEditorElement::AeTypeField: sipType = sipType_QgsAttributeEditorField; break; case QgsAttributeEditorElement::AeTypeRelation: sipType = sipType_QgsAttributeEditorRelation; break; default: sipType = nullptr; break; } %End public: enum AttributeEditorType { AeTypeContainer, AeTypeField, AeTypeRelation, AeTypeInvalid, AeTypeQmlElement, AeTypeHtmlElement }; QgsAttributeEditorElement( AttributeEditorType type, const QString &name, QgsAttributeEditorElement *parent = 0 ); %Docstring Constructor :param type: The type of the new element. :param name: :param parent: %End virtual ~QgsAttributeEditorElement(); QString name() const; %Docstring Returns the name of this element :return: The name for this element %End AttributeEditorType type() const; %Docstring The type of this element :return: The type %End QgsAttributeEditorElement *parent() const; %Docstring Gets the parent of this element. .. versionadded:: 3.0 %End QDomElement toDomElement( QDomDocument &doc ) const; %Docstring Gets the XML Dom element to save this element. :param doc: The QDomDocument which is used to create new XML elements :return: A DOM element to serialize this element %End virtual QgsAttributeEditorElement *clone( QgsAttributeEditorElement *parent ) const = 0 /Factory/; %Docstring Returns a clone of this element. To be implemented by subclasses. .. versionadded:: 3.0 %End bool showLabel() const; %Docstring Controls if this element should be labeled with a title (field, relation or groupname). .. versionadded:: 2.18 %End void setShowLabel( bool showLabel ); %Docstring Controls if this element should be labeled with a title (field, relation or groupname). .. versionadded:: 2.18 %End QString labelExpression() const; %Docstring Returns the (possibly empty or inactive) label expression. .. seealso:: :py:func:`labelExpressionIsActive` .. versionadded:: 3.14 %End void setLabelExpression( const QString &labelExpression ); %Docstring Sets the label expression override for the field to ``labelExpression``. If the override is not active or it is set to an empty string the field label will be taken from the label alias if set or from the field name otherwise. .. seealso:: :py:func:`setLabelExpressionIsActive` .. versionadded:: 3.14 %End bool labelExpressionIsActive() const; %Docstring Returns the status of the label expression override. .. versionadded:: 3.14 %End void setLabelExpressionIsActive( bool labelExpressionIsActive ); %Docstring Sets the status of a label expression override to ``labelExpressionIsActive``. .. versionadded:: 3.14 %End protected: }; class QgsAttributeEditorContainer : QgsAttributeEditorElement { %Docstring This is a container for attribute editors, used to group them visually in the attribute form if it is set to the drag and drop designer. %End %TypeHeaderCode #include "qgsattributeeditorelement.h" %End public: QgsAttributeEditorContainer( const QString &name, QgsAttributeEditorElement *parent, const QColor &backgroundColor = QColor() ); %Docstring Creates a new attribute editor container :param name: The name to show as title :param parent: The parent. May be another container. :param backgroundColor: The optional background color of the container. %End ~QgsAttributeEditorContainer(); virtual void addChildElement( QgsAttributeEditorElement *element /Transfer/ ); %Docstring Add a child element to this container. This may be another container, a field or a relation. :param element: The element to add as child %End virtual void setIsGroupBox( bool isGroupBox ); %Docstring Determines if this container is rendered as collapsible group box or tab in a tabwidget :param isGroupBox: If ``True``, this will be a group box %End virtual bool isGroupBox() const; %Docstring Returns if this container is going to be rendered as a group box :return: ``True`` if it will be a group box, ``False`` if it will be a tab %End QList children() const; %Docstring Gets a list of the children elements of this container :return: A list of elements %End virtual QList findElements( AttributeEditorType type ) const; %Docstring Traverses the element tree to find any element of the specified type :param type: The type which should be searched :return: A list of elements of the type which has been searched for %End void clear(); %Docstring Clear all children from this container. %End void setName( const QString &name ); %Docstring Change the name of this container %End int columnCount() const; %Docstring Gets the number of columns in this group %End void setColumnCount( int columnCount ); %Docstring Set the number of columns in this group %End virtual QgsAttributeEditorElement *clone( QgsAttributeEditorElement *parent ) const /Factory/; %Docstring Creates a deep copy of this element. To be implemented by subclasses. .. versionadded:: 3.0 %End QgsOptionalExpression visibilityExpression() const; %Docstring The visibility expression is used in the attribute form to show or hide this container based on an expression incorporating the field value controlled by editor widgets. .. versionadded:: 3.0 %End void setVisibilityExpression( const QgsOptionalExpression &visibilityExpression ); %Docstring The visibility expression is used in the attribute form to show or hide this container based on an expression incorporating the field value controlled by editor widgets. .. versionadded:: 3.0 %End QColor backgroundColor() const; %Docstring backgroundColor :return: background color of the container .. versionadded:: 3.8 %End void setBackgroundColor( const QColor &backgroundColor ); %Docstring Sets the background color to ``backgroundColor`` %End }; class QgsAttributeEditorField : QgsAttributeEditorElement { %Docstring This element will load a field's widget onto the form. %End %TypeHeaderCode #include "qgsattributeeditorelement.h" %End public: QgsAttributeEditorField( const QString &name, int idx, QgsAttributeEditorElement *parent ); %Docstring Creates a new attribute editor element which represents a field :param name: The name of the element :param idx: The index of the field which should be embedded :param parent: The parent of this widget (used as container) %End int idx() const; %Docstring Returns the index of the field. %End virtual QgsAttributeEditorElement *clone( QgsAttributeEditorElement *parent ) const /Factory/; }; class QgsAttributeEditorRelation : QgsAttributeEditorElement { %Docstring This element will load a relation editor onto the form. %End %TypeHeaderCode #include "qgsattributeeditorelement.h" %End public: QgsAttributeEditorRelation( const QString &name, const QString &relationId, QgsAttributeEditorElement *parent ); %Docstring .. deprecated:: QGIS 3.0.2. The name parameter is not used for anything and overwritten by the relationId internally. %End QgsAttributeEditorRelation( const QString &name, const QgsRelation &relation, QgsAttributeEditorElement *parent ); %Docstring .. deprecated:: QGIS 3.0.2. The name parameter is not used for anything and overwritten by the relationId internally. %End QgsAttributeEditorRelation( const QString &relationId, QgsAttributeEditorElement *parent ); %Docstring Creates a new element which embeds a relation. :param relationId: The id of the relation to embed :param parent: The parent (used as container) %End QgsAttributeEditorRelation( const QgsRelation &relation, QgsAttributeEditorElement *parent ); %Docstring Creates a new element which embeds a relation. :param relation: The relation to embed :param parent: The parent (used as container) %End const QgsRelation &relation() const; %Docstring Gets the id of the relation which shall be embedded :return: the id %End bool init( QgsRelationManager *relManager ); %Docstring Initializes the relation from the id :param relManager: The relation manager to use for the initialization :return: ``True`` if the relation was found in the relationmanager %End virtual QgsAttributeEditorElement *clone( QgsAttributeEditorElement *parent ) const /Factory/; bool showLinkButton() const; %Docstring Determines if the "link feature" button should be shown .. versionadded:: 2.18 %End void setShowLinkButton( bool showLinkButton ); %Docstring Determines if the "link feature" button should be shown .. versionadded:: 2.18 %End bool showUnlinkButton() const; %Docstring Determines if the "unlink feature" button should be shown .. versionadded:: 2.18 %End void setShowUnlinkButton( bool showUnlinkButton ); %Docstring Determines if the "unlink feature" button should be shown .. versionadded:: 2.18 %End void setShowSaveChildEditsButton( bool showSaveChildEditsButton ); %Docstring Determines if the "save child layer edits" button should be shown .. versionadded:: 3.14 %End bool showSaveChildEditsButton( ) const; %Docstring Returns ``True`` if the "save child layer edits" button should be shown. .. versionadded:: 3.14 %End }; class QgsAttributeEditorQmlElement : QgsAttributeEditorElement { %Docstring An attribute editor widget that will represent arbitrary QML code. .. versionadded:: 3.4 %End %TypeHeaderCode #include "qgsattributeeditorelement.h" %End public: QgsAttributeEditorQmlElement( const QString &name, QgsAttributeEditorElement *parent ); %Docstring Creates a new element which can display QML :param name: The name of the widget :param parent: The parent (used as container) %End virtual QgsAttributeEditorElement *clone( QgsAttributeEditorElement *parent ) const /Factory/; QString qmlCode() const; %Docstring The QML code that will be represented within this widget. .. versionadded:: 3.4 %End void setQmlCode( const QString &qmlCode ); %Docstring Sets the QML code that will be represented within this widget to ``qmlCode``. %End }; class QgsAttributeEditorHtmlElement : QgsAttributeEditorElement { %Docstring An attribute editor widget that will represent arbitrary HTML code. .. versionadded:: 3.8 %End %TypeHeaderCode #include "qgsattributeeditorelement.h" %End public: QgsAttributeEditorHtmlElement( const QString &name, QgsAttributeEditorElement *parent ); %Docstring Creates a new element which can display HTML :param name: The name of the widget :param parent: The parent (used as container) %End virtual QgsAttributeEditorElement *clone( QgsAttributeEditorElement *parent ) const /Factory/; QString htmlCode() const; %Docstring The QML code that will be represented within this widget. .. versionadded:: 3.4 %End void setHtmlCode( const QString &htmlCode ); %Docstring Sets the HTML code that will be represented within this widget to ``htmlCode``. %End }; /************************************************************************ * This file has been generated automatically from * * * * src/core/qgsattributeeditorelement.h * * * * Do not edit manually ! Edit header and run scripts/sipify.pl again * ************************************************************************/