qgscodeeditorcolorscheme.h

Go to the documentation of this file.

/***************************************************************************
    qgscodeeditorcolorscheme.h
     --------------------------------------
    Date                 : October 2020
    Copyright            : (C) 2020 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 QGSCODEEDITORCOLORSCHEME_H
#define QGSCODEEDITORCOLORSCHEME_H
 
#include "qgis_gui.h"
#include "qgis_sip.h"
 
#include <QColor>
#include <QMap>
#include <QString>

class GUI_EXPORT QgsCodeEditorColorScheme
{
  public:
    enum class ColorRole
    {
      Default,                
      Keyword,                
      Class,                  
      Method,                 
      Decoration,             
      Number,                 
      Comment,                
      CommentLine,            
      CommentBlock,           
      Background,             
      Cursor,                 
      CaretLine,              
      SingleQuote,            
      DoubleQuote,            
      TripleSingleQuote,      
      TripleDoubleQuote,      
      Operator,               
      QuotedOperator,         
      Identifier,             
      QuotedIdentifier,       
      Tag,                    
      UnknownTag,             
      MarginBackground,       
      MarginForeground,       
      SelectionBackground,    
      SelectionForeground,    
      MatchedBraceBackground, 
      MatchedBraceForeground, 
      Edge,                   
      Fold,                   
      Error,                  
      ErrorBackground,        
      FoldIconForeground,     
      FoldIconHalo,           
      IndentationGuide,       
      SearchMatchBackground,  
    };

    QgsCodeEditorColorScheme( const QString &id = QString(), const QString &name = QString() );
 

    QString id() const { return mId; }

    QString name() const { return mThemeName; }

    QColor color( ColorRole role ) const;

    void setColor( ColorRole role, const QColor &color );

    void setColors( const QMap<ColorRole, QColor> &colors ) SIP_SKIP;
 
  private:
    QString mId;
    QString mThemeName;
    QMap<ColorRole, QColor> mColors;
};
 
#endif // QGSCODEEDITORCOLORSCHEME_H