FxUIPalette.h

Go to the documentation of this file.

//
// (C) Copyright 2005-2025 by Graebert GmbH.
//
// Permission to use, copy, modify, and distribute this software in
// object code form for any purpose and without fee is hereby granted, 
// provided that the above copyright notice appears in all copies and 
// that both that copyright notice and the limited warranty and
// restricted rights notice below appear in all supporting 
// documentation.
//
// GRAEBERT PROVIDES THIS PROGRAM "AS IS" AND WITH ALL FAULTS. 
// GRAEBERT SPECIFICALLY DISCLAIMS ANY IMPLIED WARRANTY OF
// MERCHANTABILITY OR FITNESS FOR A PARTICULAR USE.  GRAEBERT GMBH 
// DOES NOT WARRANT THAT THE OPERATION OF THE PROGRAM WILL BE
// UNINTERRUPTED OR ERROR FREE.
 
#pragma once

 
#include "../FxCommonFramework.h"
#include "FxUIColor.h"
#include "../UI/FxUIObject.h"
 
class QPalette;
class CFxUIPaletteImpl;
 
class COMMONUI_API CFxUIPalette 
{
public:

    enum FxUIColorGroup
    {
        Active,
        Disabled,
        Inactive,
        NColorGroups,
        Current,
        All,
        Normal = Active
    };

   enum FxUIColorRole
    {
        WindowText,
        Button,
        Light,
        Midlight,
        Dark,
        Mid,
        Text,
        BrightText,
        ButtonText,
        Base,
        Window,
        Shadow,
        Highlight,
        HighlightedText,
        Link,
        LinkVisited,
        AlternateBase,
        NoRole,
        ToolTipBase,
        ToolTipText,
        PlaceholderText,
        NColorRoles = PlaceholderText + 1,
    };
 
public:

    CFxUIPalette();

    CFxUIPalette( const QPalette& pal );

    CFxUIPalette( const CFxUIPalette& pal );

    ~CFxUIPalette();

    CFxUIPalette& operator=( const CFxUIPalette& pal );

    const QPalette& operator()() const;

    bool isBrushSet( CFxUIPalette::FxUIColorGroup cg, CFxUIPalette::FxUIColorRole colorRole ) const;

    CFxUIColor color( CFxUIPalette::FxUIColorRole role ) const;

    void setColor( CFxUIPalette::FxUIColorRole role, const CFxUIColor& color );
 
protected:
    CFxUIPaletteImpl* m_pImpl{ nullptr };
};