FX::FXHeaderItem Class Reference

Header item. More...

#include <FXHeader.h>

Inheritance diagram for FX::FXHeaderItem:

List of all members.

Public Types
enum	{   ARROW_NONE = 0,   ARROW_UP = 1,   ARROW_DOWN = 2,   PRESSED = 4,   RIGHT = 8,   LEFT = 16,   CENTER_X = 0,   TOP = 32,   BOTTOM = 64,   CENTER_Y = 0,   BEFORE = 128,   AFTER = 256,   ABOVE = 512,   BELOW = 1024 }
Public Member Functions
	FXHeaderItem (const FXString &text, FXIcon *ic=NULL, FXint s=0, void *ptr=NULL)
virtual void	setText (const FXString &txt)
const FXString &	getText () const
virtual void	setIcon (FXIcon *icn)
FXIcon *	getIcon () const
void	setData (void *ptr)
void *	getData () const
void	setSize (FXint s)
FXint	getSize () const
void	setPos (FXint p)
FXint	getPos () const
void	setArrowDir (FXbool dir=MAYBE)
FXbool	getArrowDir () const
void	setJustify (FXuint justify=LEFT|CENTER_Y)
FXuint	getJustify () const
void	setIconPosition (FXuint mode=BEFORE)
FXuint	getIconPosition () const
void	setPressed (FXbool pressed)
FXbool	isPressed () const
virtual FXint	getWidth (const FXHeader *header) const
virtual FXint	getHeight (const FXHeader *header) const
virtual void	create ()
virtual void	detach ()
virtual void	destroy ()
virtual void	save (FXStream &store) const
virtual void	load (FXStream &store)
virtual	~FXHeaderItem ()
Friends
class	FXHeader

---

Detailed Description

Header item.

See also:

• Header style options.

---

Member Enumeration Documentation

anonymous enum

Enumerator:

ARROW_NONE
ARROW_UP	No arrow.
ARROW_DOWN	Arrow pointing up.
PRESSED	Arrow pointing down.
RIGHT	Pressed down.
LEFT	Align on right.
CENTER_X	Align on left.
TOP	Aling centered horizontally (default).
BOTTOM	Align on top.
CENTER_Y	Align on bottom.
BEFORE	Aling centered vertically (default).
AFTER	Icon before the text.
ABOVE	Icon after the text.
BELOW	Icon above the text.

---

Constructor & Destructor Documentation

FX::FXHeaderItem::FXHeaderItem	(	const FXString &	text,
		FXIcon *	ic = NULL,
		FXint	s = 0,
		void *	ptr = NULL
	)			[inline]

Construct new item with given text, icon, size, and user-data.

virtual FX::FXHeaderItem::~FXHeaderItem

(

)

[inline, virtual]

Destructor.

---

Member Function Documentation

virtual void FX::FXHeaderItem::setText

(

const FXString &

txt

)

[virtual]

Change item's text label.

const FXString& FX::FXHeaderItem::getText

(

)

const [inline]

Return item's text label.

virtual void FX::FXHeaderItem::setIcon

(

FXIcon *

icn

)

[virtual]

Change item's icon.

FXIcon* FX::FXHeaderItem::getIcon

(

)

const [inline]

Return item's icon.

void FX::FXHeaderItem::setData

(

void *

ptr

)

[inline]

Change item's user data.

void* FX::FXHeaderItem::getData

(

)

const [inline]

Get item's user data.

void FX::FXHeaderItem::setSize

(

FXint

s

)

[inline]

Change size.

FXint FX::FXHeaderItem::getSize

(

)

const [inline]

Obtain current size.

void FX::FXHeaderItem::setPos

(

FXint

p

)

[inline]

Change position.

FXint FX::FXHeaderItem::getPos

(

)

const [inline]

Obtain current position.

void FX::FXHeaderItem::setArrowDir

(

FXbool

dir = MAYBE

)

Change sort direction (FALSE, TRUE, MAYBE).

FXbool FX::FXHeaderItem::getArrowDir

(

)

const

Return sort direction (FALSE, TRUE, MAYBE).

void FX::FXHeaderItem::setJustify

(

FXuint

justify = LEFT|CENTER_Y

)

Change content justification.

FXuint FX::FXHeaderItem::getJustify

(

)

const [inline]

Return content justification.

void FX::FXHeaderItem::setIconPosition

(

FXuint

mode = BEFORE

)

Change icon position.

FXuint FX::FXHeaderItem::getIconPosition

(

)

const [inline]

Return icon position.

void FX::FXHeaderItem::setPressed

(

FXbool

pressed

)

Change state to pressed.

FXbool FX::FXHeaderItem::isPressed

(

)

const [inline]

Return pressed state.

virtual FXint FX::FXHeaderItem::getWidth

(

const FXHeader *

header

)

const [virtual]

Return the item's content width in the header.

virtual FXint FX::FXHeaderItem::getHeight

(

const FXHeader *

header

)

const [virtual]

Return the item's content height in the header.

virtual void FX::FXHeaderItem::create

(

)

[virtual]

Create server-side resources.

virtual void FX::FXHeaderItem::detach

(

)

[virtual]

Detach from server-side resources.

virtual void FX::FXHeaderItem::destroy

(

)

[virtual]

Destroy server-side resources.

virtual void FX::FXHeaderItem::save

(

FXStream &

store

)

const [virtual]

Stream serialization.

Reimplemented from FX::FXObject.

virtual void FX::FXHeaderItem::load

(

FXStream &

store

)

[virtual]

Load object from stream.

Reimplemented from FX::FXObject.

---

Friends And Related Function Documentation

friend class FXHeader [friend]