Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :                              qgslayermetadataformatter.h
       3                 :            :                              ---------------------------
       4                 :            :     begin                : September 2017
       5                 :            :     copyright            : (C) 2017 by Etienne Trimaille
       6                 :            :     email                : etienne dot trimaille at gmail dot com
       7                 :            :  ***************************************************************************/
       8                 :            : 
       9                 :            : /***************************************************************************
      10                 :            :  *                                                                         *
      11                 :            :  *   This program is free software; you can redistribute it and/or modify  *
      12                 :            :  *   it under the terms of the GNU General Public License as published by  *
      13                 :            :  *   the Free Software Foundation; either version 2 of the License, or     *
      14                 :            :  *   (at your option) any later version.                                   *
      15                 :            :  *                                                                         *
      16                 :            :  ***************************************************************************/
      17                 :            : 
      18                 :            : #ifndef QGSLAYERMETADATAFORMATTER_H
      19                 :            : #define QGSLAYERMETADATAFORMATTER_H
      20                 :            : 
      21                 :            : #include <QCoreApplication>
      22                 :            : 
      23                 :            : #include "qgis_sip.h"
      24                 :            : #include "qgis_core.h"
      25                 :            : #include "qgslayermetadata.h"
      26                 :            : 
      27                 :            : /**
      28                 :            :  * \ingroup core
      29                 :            :  * \class QgsLayerMetadataFormatter
      30                 :            :  * \brief Class for metadata formatter.
      31                 :            :  * \since QGIS 3.0
      32                 :            :  */
      33                 :          0 : class CORE_EXPORT QgsLayerMetadataFormatter
      34                 :            : {
      35                 :          0 :     Q_DECLARE_TR_FUNCTIONS( "QgsLayerMetadataFormatter" )
      36                 :            : 
      37                 :            :   public:
      38                 :            : 
      39                 :            :     /**
      40                 :            :      * Constructor for QgsLayerMetadataFormatter
      41                 :            :      */
      42                 :            :     QgsLayerMetadataFormatter( const QgsLayerMetadata &metadata );
      43                 :            : 
      44                 :            :     /**
      45                 :            :      * Formats the "Access" section according to a \a metadata object.
      46                 :            :      * This will return a HTML table.
      47                 :            :      */
      48                 :            :     QString accessSectionHtml() const;
      49                 :            : 
      50                 :            :     /**
      51                 :            :      * Formats the "Contacts" section according to a \a metadata object.
      52                 :            :      * This will return a HTML table.
      53                 :            :      */
      54                 :            :     QString contactsSectionHtml() const;
      55                 :            : 
      56                 :            :     /**
      57                 :            :      * Formats the "Extents" section according to a \a metadata object (extent and temporal).
      58                 :            :      * This will return a HTML table.
      59                 :            :      * \param showSpatialExtent flag if the spatial extent needs to be displayed. Default to TRUE.
      60                 :            :      */
      61                 :            :     QString extentSectionHtml( const bool showSpatialExtent = true ) const;
      62                 :            : 
      63                 :            :     /**
      64                 :            :      * Formats the "Identification" section according to a \a metadata object.
      65                 :            :      * This will return a HTML table.
      66                 :            :      */
      67                 :            :     QString identificationSectionHtml() const;
      68                 :            : 
      69                 :            :     /**
      70                 :            :      * Formats the "History" section according to a \a metadata object.
      71                 :            :      * This will return a HTML table.
      72                 :            :      */
      73                 :            :     QString historySectionHtml() const;
      74                 :            : 
      75                 :            :     /**
      76                 :            :      * Formats the "Links" section according to a \a metadata object.
      77                 :            :      * This will return a HTML table.
      78                 :            :      */
      79                 :            :     QString linksSectionHtml() const;
      80                 :            : 
      81                 :            :   private:
      82                 :            :     QgsLayerMetadata mMetadata;
      83                 :            : };
      84                 :            : 
      85                 :            : #endif // QGSLAYERMETADATAFORMATTER_H