CFxUIIcon Class Reference

#include <FxUIIcon.h>

Public Types
enum	Mode { Normal = 0 , Disabled = 1 , Active = 2 , Selected = 3 }
enum	State { Off = 1 , On = 0 }

Public Member Functions
	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 Attributes
CFxUIIconImpl *	m_pImpl = nullptr

Detailed Description

Definition at line 40 of file FxUIIcon.h.

Member Enumeration Documentation

Mode

enum CFxUIIcon::Mode

Enumerator
Normal
Disabled
Active
Selected

Definition at line 44 of file FxUIIcon.h.

State

enum CFxUIIcon::State

Enumerator
Off
On

Definition at line 52 of file FxUIIcon.h.

Constructor & Destructor Documentation

CFxUIIcon() [1/5]

CFxUIIcon::CFxUIIcon

(

)

Constructor

CFxUIIcon() [2/5]

CFxUIIcon::CFxUIIcon

(

const CFxUIPixmap &

pixmap

)

Parameterized Constructor

CFxUIIcon() [3/5]

CFxUIIcon::CFxUIIcon

(

const CFxUIString &

fileName

)

CFxUIIcon() [4/5]

CFxUIIcon::CFxUIIcon

(

const CFxUIIcon &

icon

)

Copy Constructor

CFxUIIcon() [5/5]

CFxUIIcon::CFxUIIcon

(

const FxNativeIcon &

icon

)

~CFxUIIcon()

CFxUIIcon::~CFxUIIcon

(

)

Destructor

Member Function Documentation

addFile()

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

Adds an image from the file with the given fileName to the icon, as a specialization for size, mode and state.

Parameters

filename	as CFxUIString
CFxUISize
CFxUIIcon::Mode
CFxUIIcon::State

isNull()

bool CFxUIIcon::isNull

(

)

const

Returns true if the icon is empty, otherwise returns false.

Returns

bool

operator const FxNativeIcon &()

CFxUIIcon::operator const FxNativeIcon &

(

)

const

operator=()

CFxUIIcon & CFxUIIcon::operator=

(

const CFxUIIcon &

icon

)

Assignment operator

pixmap() [1/2]

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

Returns a pixmap with the requested size, mode, and state, generating one if necessary.

Parameters

CFxUISize
CFxUIIcon::Mode
CFxUIIcon::State

Returns

CFxUIPixmap

pixmap() [2/2]

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

Returns a pixmap of size CFxUISize(w, h). The pixmap might be smaller than requested, but never larger, unless the device-pixel ratio of the returned pixmap is larger than 1.

Parameters

width
height
CFxUIIcon::Mode
CFxUIIcon::State

Returns

CFxUIPixmap

setUrl()

void CFxUIIcon::setUrl

(

CFxUIString

url

)

Sets the link.

Parameters

url

url()

CFxUIString CFxUIIcon::url

(

)

const

Returns the link URL.

Returns

CFxUIString

Member Data Documentation

m_pImpl

CFxUIIconImpl* CFxUIIcon::m_pImpl = nullptr

protected

Definition at line 140 of file FxUIIcon.h.

---

The documentation for this class was generated from the following file:

• FxUIIcon.h