HG_REPOSITORIES/LPP/SciQLOP_Repos/SciQLop Files · core/include/DataSource/DataSourceItem.h

(Minor) Fixes vera warnings for AMDA plugin

Alexandre Leroux - - Load All Authors

File last commit:

r1036:9c3bb5e93c54


                r1119:d60c64f6f148

Download file

             DataSourceItem.h
        
                    154 lines
            
             | 4.9 KiB
            
                | text/x-c
            
             |
                CLexer
            
             / core / include / DataSource / DataSourceItem.h
          
                    History
                
                 |
                  Source
                 | Raw
                 |Copy content
                 |Copy permalink

        Alexandre Leroux
    
Define a data source item

              r35
            
      #ifndef SCIQLOP_DATASOURCEITEM_H

      #define SCIQLOP_DATASOURCEITEM_H

        Alexandre Leroux
    
Exports core module as a shared library...

              r461
            
      #include "CoreGlobal.h"

        Alexandre Leroux
    
Define a data source item

              r35
            
      #include <Common/spimpl.h>

      #include <QVariant>

      #include <QVector>

        Alexandre Leroux
    
Defines actions for a data source items...

              r144
            
      class DataSourceItemAction;

        Alexandre Leroux
    
Adds type for a data source item...

              r79
            
      /**

       * Possible types of an item

       */

        Alexandre Leroux
    
Changes data source item icons (1)...

              r344
            
      enum class DataSourceItemType { NODE, PRODUCT, COMPONENT };

        Alexandre Leroux
    
Adds type for a data source item...

              r79
            
        Alexandre Leroux
    
Define a data source item

              r35
            
      /**

       * @brief The DataSourceItem class aims to represent a structure element of a data source.

       * A data source has a tree structure that is made up of a main DataSourceItem object (root)

       * containing other DataSourceItem objects (children).

       * For each DataSourceItem can be associated a set of data representing it.

       */

        Alexandre Leroux
    
Exports core module as a shared library...

              r461
            
      class SCIQLOP_CORE_EXPORT DataSourceItem {

        Alexandre Leroux
    
Define a data source item

              r35
            
      public:

        Alexandre Leroux
    
Changes structure of data hold by the item...

              r342
            
          /// Key associated with the name of the item

          static const QString NAME_DATA_KEY;

        Alexandre Leroux
    
Sets the name of the plugin for products and components...

              r1036
            
          /// Key associated with the plugin of the item

          static const QString PLUGIN_DATA_KEY;

        Alexandre Leroux
    
Changes structure of data hold by the item...

              r342
            
          explicit DataSourceItem(DataSourceItemType type, const QString &name);

        Alexandre Leroux
    
(Minor) Uses QVariantHash alias in DataSourceItem

              r407
            
          explicit DataSourceItem(DataSourceItemType type, QVariantHash data = {});

        Alexandre Leroux
    
Define a data source item

              r35
            
        Alexandre Leroux
    
Implements merge method (2)...

              r1033
            
          std::unique_ptr<DataSourceItem> clone() const;

        Alexandre Leroux
    
Defines actions for a data source items...

              r144
            
          /// @return the actions of the item as a vector

          QVector<DataSourceItemAction *> actions() const noexcept;

          /**

           * Adds an action to the item. The item takes ownership of the action, and the action is

           * automatically associated to the item

           * @param action the action to add

           */

          void addAction(std::unique_ptr<DataSourceItemAction> action) noexcept;

        Alexandre Leroux
    
Define a data source item

              r35
            
          /**

           * Adds a child to the item. The item takes ownership of the child.

           * @param child the child to add

           */

          void appendChild(std::unique_ptr<DataSourceItem> child) noexcept;

          /**

           * Returns the item's child associated to an index

           * @param childIndex the index to search

           * @return a pointer to the child if index is valid, nullptr otherwise

           */

          DataSourceItem *child(int childIndex) const noexcept;

          int childCount() const noexcept;

          /**

        Alexandre Leroux
    
Changes structure of data hold by the item...

              r342
            
           * Get the data associated to a key

           * @param key the key to search

           * @return the data found if key is valid, default QVariant otherwise

        Alexandre Leroux
    
Define a data source item

              r35
            
           */

        Alexandre Leroux
    
Changes structure of data hold by the item...

              r342
            
          QVariant data(const QString &key) const noexcept;

        Alexandre Leroux
    
Define a data source item

              r35
            
        Alexandre Leroux
    
Handles tooltip for a data source item

              r346
            
          /// Gets all data

        Alexandre Leroux
    
(Minor) Uses QVariantHash alias in DataSourceItem

              r407
            
          QVariantHash data() const noexcept;

        Alexandre Leroux
    
Handles tooltip for a data source item

              r346
            
        Alexandre Leroux
    
Inits merge method of two items

              r1031
            
          /**

           * Merge in the item the source item passed as parameter.

           *

           * The merge is done by adding as child of the item the complete tree represented by the source

           * item. If a part of the tree already exists in the item (based on the name of the nodes), it

           * is merged by completing the existing tree by items "leaves" (products, components or nodes

           * with no child).

           *

           * For example, with item representing the tree:

           * R (root node)

           *   - N1 (node)

           *     -- N11 (node)

           *        --- P1 (product)

           *        --- P2 (product)

           *   - N2 (node)

           *

           * and the source item representing the tree:

           * N1 (root node)

           *   - N11 (node)

           *     -- P3 (product)

           *   - N12 (node)

           *

           * The leaves of the source item to merge into the item are N1/N11/P3 and N1/N12 => we therefore

           * have the following merge result:

           * R

           *   - N1

           *     -- N11

           *        --- P1

           *        --- P2

           *        --- P3 (added leaf)

           *     -- N12 (added leaf)

           *

           * @param item the source item

           * @remarks No control is performed on products or components that are merged into the same tree

           * part (two products or components may have the same name)

           * @remarks the merge is made by copy (source item is not changed and still exists after the

           * operation)

           */

          void merge(const DataSourceItem &item);

        Alexandre Leroux
    
Changes data source item icons (2)...

              r345
            
          bool isRoot() const noexcept;

        Alexandre Leroux
    
Adds action in the mock plugin to load products

              r146
            
          QString name() const noexcept;

        Alexandre Leroux
    
Define a data source item

              r35
            
          /**

           * Get the item's parent

           * @return a pointer to the parent if it exists, nullptr if the item is a root

           */

          DataSourceItem *parentItem() const noexcept;

        Alexandre Leroux
    
Adds plugin column to variable widget...

              r551
            
          /**

           * Gets the item's root

           * @return the top parent, the item itself if it's the root item

           */

          const DataSourceItem &rootItem() const noexcept;

        Alexandre Leroux
    
Implements DataSourceItem::setData() method...

              r347
            
          /**

           * Sets or appends a value to a key

           * @param key the key

           * @param value the value

           * @param append if true, the value is added to the values already existing for the key,

           * otherwise it replaces the existing values

           */

          void setData(const QString &key, const QVariant &value, bool append = false) noexcept;

        Alexandre Leroux
    
Adds type for a data source item...

              r79
            
          DataSourceItemType type() const noexcept;

        trabillard
    
Drop of product in variables

              r870
            
          /**

           * @brief Searches the first child matching the specified data.

           * @param data The data to search.

           * @param recursive So the search recursively.

           * @return the item matching the data or nullptr if it was not found.

           */

          DataSourceItem *findItem(const QVariantHash &data, bool recursive);

        Alexandre Leroux
    
Adds operators for DataSourceItem

              r348
            
          bool operator==(const DataSourceItem &other);

          bool operator!=(const DataSourceItem &other);

        Alexandre Leroux
    
Define a data source item

              r35
            
      private:

          class DataSourceItemPrivate;

          spimpl::unique_impl_ptr<DataSourceItemPrivate> impl;

      };

      #endif // SCIQLOP_DATASOURCEITEMMODEL_H

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

Alexandre Leroux Define a data source item	r35	#ifndef SCIQLOP_DATASOURCEITEM_H
		#define SCIQLOP_DATASOURCEITEM_H

Alexandre Leroux Exports core module as a shared library...	r461	#include "CoreGlobal.h"

Alexandre Leroux Define a data source item	r35	#include <Common/spimpl.h>

		#include <QVariant>
		#include <QVector>

Alexandre Leroux Defines actions for a data source items...	r144	class DataSourceItemAction;

Alexandre Leroux Adds type for a data source item...	r79	/**
		* Possible types of an item
		*/
Alexandre Leroux Changes data source item icons (1)...	r344	enum class DataSourceItemType { NODE, PRODUCT, COMPONENT };
Alexandre Leroux Adds type for a data source item...	r79
Alexandre Leroux Define a data source item	r35	/**
		* @brief The DataSourceItem class aims to represent a structure element of a data source.
		* A data source has a tree structure that is made up of a main DataSourceItem object (root)
		* containing other DataSourceItem objects (children).
		* For each DataSourceItem can be associated a set of data representing it.
		*/
Alexandre Leroux Exports core module as a shared library...	r461	class SCIQLOP_CORE_EXPORT DataSourceItem {
Alexandre Leroux Define a data source item	r35	public:
Alexandre Leroux Changes structure of data hold by the item...	r342	/// Key associated with the name of the item
		static const QString NAME_DATA_KEY;
Alexandre Leroux Sets the name of the plugin for products and components...	r1036	/// Key associated with the plugin of the item
		static const QString PLUGIN_DATA_KEY;
Alexandre Leroux Changes structure of data hold by the item...	r342
		explicit DataSourceItem(DataSourceItemType type, const QString &name);
Alexandre Leroux (Minor) Uses QVariantHash alias in DataSourceItem	r407	explicit DataSourceItem(DataSourceItemType type, QVariantHash data = {});
Alexandre Leroux Define a data source item	r35
Alexandre Leroux Implements merge method (2)...	r1033	std::unique_ptr<DataSourceItem> clone() const;

Alexandre Leroux Defines actions for a data source items...	r144	/// @return the actions of the item as a vector
		QVector<DataSourceItemAction *> actions() const noexcept;

		/**
		* Adds an action to the item. The item takes ownership of the action, and the action is
		* automatically associated to the item
		* @param action the action to add
		*/
		void addAction(std::unique_ptr<DataSourceItemAction> action) noexcept;

Alexandre Leroux Define a data source item	r35	/**
		* Adds a child to the item. The item takes ownership of the child.
		* @param child the child to add
		*/
		void appendChild(std::unique_ptr<DataSourceItem> child) noexcept;

		/**
		* Returns the item's child associated to an index
		* @param childIndex the index to search
		* @return a pointer to the child if index is valid, nullptr otherwise
		*/
		DataSourceItem *child(int childIndex) const noexcept;

		int childCount() const noexcept;

		/**
Alexandre Leroux Changes structure of data hold by the item...	r342	* Get the data associated to a key
		* @param key the key to search
		* @return the data found if key is valid, default QVariant otherwise
Alexandre Leroux Define a data source item	r35	*/
Alexandre Leroux Changes structure of data hold by the item...	r342	QVariant data(const QString &key) const noexcept;
Alexandre Leroux Define a data source item	r35
Alexandre Leroux Handles tooltip for a data source item	r346	/// Gets all data
Alexandre Leroux (Minor) Uses QVariantHash alias in DataSourceItem	r407	QVariantHash data() const noexcept;
Alexandre Leroux Handles tooltip for a data source item	r346
Alexandre Leroux Inits merge method of two items	r1031	/**
		* Merge in the item the source item passed as parameter.
		*
		* The merge is done by adding as child of the item the complete tree represented by the source
		* item. If a part of the tree already exists in the item (based on the name of the nodes), it
		* is merged by completing the existing tree by items "leaves" (products, components or nodes
		* with no child).
		*
		* For example, with item representing the tree:
		* R (root node)
		* - N1 (node)
		* -- N11 (node)
		* --- P1 (product)
		* --- P2 (product)
		* - N2 (node)
		*
		* and the source item representing the tree:
		* N1 (root node)
		* - N11 (node)
		* -- P3 (product)
		* - N12 (node)
		*
		* The leaves of the source item to merge into the item are N1/N11/P3 and N1/N12 => we therefore
		* have the following merge result:
		* R
		* - N1
		* -- N11
		* --- P1
		* --- P2
		* --- P3 (added leaf)
		* -- N12 (added leaf)
		*
		* @param item the source item
		* @remarks No control is performed on products or components that are merged into the same tree
		* part (two products or components may have the same name)
		* @remarks the merge is made by copy (source item is not changed and still exists after the
		* operation)
		*/
		void merge(const DataSourceItem &item);

Alexandre Leroux Changes data source item icons (2)...	r345	bool isRoot() const noexcept;

Alexandre Leroux Adds action in the mock plugin to load products	r146	QString name() const noexcept;

Alexandre Leroux Define a data source item	r35	/**
		* Get the item's parent
		* @return a pointer to the parent if it exists, nullptr if the item is a root
		*/
		DataSourceItem *parentItem() const noexcept;

Alexandre Leroux Adds plugin column to variable widget...	r551	/**
		* Gets the item's root
		* @return the top parent, the item itself if it's the root item
		*/
		const DataSourceItem &rootItem() const noexcept;

Alexandre Leroux Implements DataSourceItem::setData() method...	r347	/**
		* Sets or appends a value to a key
		* @param key the key
		* @param value the value
		* @param append if true, the value is added to the values already existing for the key,
		* otherwise it replaces the existing values
		*/
		void setData(const QString &key, const QVariant &value, bool append = false) noexcept;

Alexandre Leroux Adds type for a data source item...	r79	DataSourceItemType type() const noexcept;

trabillard Drop of product in variables	r870	/**
		* @brief Searches the first child matching the specified data.
		* @param data The data to search.
		* @param recursive So the search recursively.
		* @return the item matching the data or nullptr if it was not found.
		*/
		DataSourceItem *findItem(const QVariantHash &data, bool recursive);

Alexandre Leroux Adds operators for DataSourceItem	r348	bool operator==(const DataSourceItem &other);
		bool operator!=(const DataSourceItem &other);

Alexandre Leroux Define a data source item	r35	private:
		class DataSourceItemPrivate;
		spimpl::unique_impl_ptr<DataSourceItemPrivate> impl;
		};

		#endif // SCIQLOP_DATASOURCEITEMMODEL_H