Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :   qgsattributeeditorhtmlelement.h - QgsAttributeEditorElement
       3                 :            : 
       4                 :            :  ---------------------
       5                 :            :  begin                : 12.01.2021
       6                 :            :  copyright            : (C) 2021 by Denis Rouzaud
       7                 :            :  email                : denis@opengis.ch
       8                 :            :  ***************************************************************************
       9                 :            :  *                                                                         *
      10                 :            :  *   This program is free software; you can redistribute it and/or modify  *
      11                 :            :  *   it under the terms of the GNU General Public License as published by  *
      12                 :            :  *   the Free Software Foundation; either version 2 of the License, or     *
      13                 :            :  *   (at your option) any later version.                                   *
      14                 :            :  *                                                                         *
      15                 :            :  ***************************************************************************/
      16                 :            : #ifndef QGSATTRIBUTEEDITORHTMLELEMENT_H
      17                 :            : #define QGSATTRIBUTEEDITORHTMLELEMENT_H
      18                 :            : 
      19                 :            : #include "qgis_core.h"
      20                 :            : #include "qgsattributeeditorelement.h"
      21                 :            : 
      22                 :            : 
      23                 :            : 
      24                 :            : /**
      25                 :            :  * \ingroup core
      26                 :            :  * \brief An attribute editor widget that will represent arbitrary HTML code.
      27                 :            :  *
      28                 :            :  * \since QGIS 3.4
      29                 :            :  */
      30                 :          0 : class CORE_EXPORT QgsAttributeEditorHtmlElement : public QgsAttributeEditorElement
      31                 :            : {
      32                 :            :   public:
      33                 :            : 
      34                 :            :     /**
      35                 :            :      * Creates a new element which can display HTML
      36                 :            :      *
      37                 :            :      * \param name         The name of the widget
      38                 :            :      * \param parent       The parent (used as container)
      39                 :            :     */
      40                 :          0 :     QgsAttributeEditorHtmlElement( const QString &name, QgsAttributeEditorElement *parent )
      41                 :          0 :       : QgsAttributeEditorElement( AeTypeHtmlElement, name, parent )
      42                 :          0 :     {}
      43                 :            : 
      44                 :            :     QgsAttributeEditorElement *clone( QgsAttributeEditorElement *parent ) const override SIP_FACTORY;
      45                 :            : 
      46                 :            :     /**
      47                 :            :      * The Html code that will be represented within this widget.
      48                 :            :      *
      49                 :            :      * \since QGIS 3.4
      50                 :            :      */
      51                 :            :     QString htmlCode() const;
      52                 :            : 
      53                 :            :     /**
      54                 :            :      * Sets the HTML code that will be represented within this widget to \a htmlCode.
      55                 :            :      */
      56                 :            :     void setHtmlCode( const QString &htmlCode );
      57                 :            : 
      58                 :            :   private:
      59                 :            :     void saveConfiguration( QDomElement &elem, QDomDocument &doc ) const override;
      60                 :            :     void loadConfiguration( const QDomElement &element,  const QString &layerId, const QgsReadWriteContext &context, const QgsFields &fields ) override;
      61                 :            :     QString typeIdentifier() const override;
      62                 :            :     QString mHtmlCode;
      63                 :            : };
      64                 :            : 
      65                 :            : 
      66                 :            : #endif // QGSATTRIBUTEEDITORHTMLELEMENT_H