qgscolorschemeregistry.h

Go to the documentation of this file.

/***************************************************************************
                             qgscolorschemeregistry.h
                             ------------------------
    begin                : July 2014
    copyright            : (C) 2014 by Nyall Dawson
    email                : nyall dot dawson at gmail dot com
 ***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef QGSCOLORSCHEMEREGISTRY_H
#define QGSCOLORSCHEMEREGISTRY_H
 
#include "qgis_core.h"
#include "qgscolorscheme.h"
 
#include <QList>

class CORE_EXPORT QgsColorSchemeRegistry
{
  public:
    QgsColorSchemeRegistry() = default;
 
    virtual ~QgsColorSchemeRegistry();

    void populateFromInstance();

    void addDefaultSchemes();

    void initStyleScheme();

    void addUserSchemes();

    void addColorScheme( QgsColorScheme *scheme SIP_TRANSFER );

    bool removeColorScheme( QgsColorScheme *scheme );

    QList<QgsColorScheme *> schemes() const;

    QList<QgsColorScheme *> schemes( QgsColorScheme::SchemeFlag flag ) const;
 

#ifndef SIP_RUN
    template<class T> void schemes( QList<T *> &schemeList ) const
    {
      schemeList.clear();
      QList<QgsColorScheme *> schemeInstanceList = schemes();
      QList<QgsColorScheme *>::iterator schemeIt = schemeInstanceList.begin();
      for ( ; schemeIt != schemeInstanceList.end(); ++schemeIt )
      {
        T *scheme = dynamic_cast<T *>( *schemeIt );
        if ( scheme )
        {
          schemeList.push_back( scheme );
        }
      }
    }
#endif

    void setRandomStyleColorScheme( QgsColorScheme *scheme );

    QgsColorScheme *randomStyleColorScheme();

    QColor fetchRandomStyleColor() const;
 
  private:
    QList< QgsColorScheme * > mColorSchemeList;
 
    QgsColorScheme *mRandomStyleColorScheme = nullptr;
    QgsNamedColorList mRandomStyleColors;
 
    mutable int mNextRandomStyleColorIndex = 0;
 
    int mNextRandomStyleColorDirection = 1;
};
 
 
#endif