FxUIIcon.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 "FxUISize.h"
#include "FxUIPixmap.h"
 
#if defined( XENON )
namespace Wt
{
    class WLink;
}
using FxNativeIcon = Wt::WLink;
#else
class QIcon;
using FxNativeIcon = QIcon;
#endif
 
class CFxUIIconImpl;
 
class COMMONUI_API CFxUIIcon
{
public:
 
    enum Mode
    {
        Normal = 0, 
        Disabled = 1, 
        Active = 2, 
        Selected = 3
    };
 
    enum State
    {
        Off = 1,
        On = 0
    };

    CFxUIIcon();

    CFxUIIcon( const CFxUIPixmap& pixmap );
    CFxUIIcon( const CFxUIString& fileName );

    CFxUIIcon( const CFxUIIcon& icon );
    CFxUIIcon( const FxNativeIcon& icon );

    ~CFxUIIcon();

    CFxUIIcon& operator=( const CFxUIIcon& icon );
 
    operator const FxNativeIcon&() const;

    bool isNull() const;

    CFxUIPixmap pixmap( const CFxUISize& size, CFxUIIcon::Mode mode = Normal, CFxUIIcon::State state = Off ) const;

    CFxUIPixmap pixmap( int w, int h, CFxUIIcon::Mode mode = Normal, CFxUIIcon::State state = Off ) const;

    void addFile( const CFxUIString& fileName, const CFxUISize& size = CFxUISize(), CFxUIIcon::Mode mode = Normal, CFxUIIcon::State state = Off );
    
    CFxUIString url() const;

    void setUrl( CFxUIString url );
 
protected:
    CFxUIIconImpl* m_pImpl = nullptr;
};