FX::FXHeaderItem Class Reference

#include <FXHeader.h>

Inheritance diagram for FX::FXHeaderItem:

Inheritance graph
[legend]

List of all members.


Detailed Description

Header item.

Public Types

enum  {
  ARROW_NONE, ARROW_UP, ARROW_DOWN, PRESSED,
  RIGHT, LEFT, CENTER_X, TOP,
  BOTTOM, CENTER_Y, BEFORE, AFTER,
  ABOVE, BELOW
}

Public Member Functions

 FXHeaderItem (const FXString &text, FXIcon *ic=NULL, FXint s=0, void *ptr=NULL)
virtual void setText (const FXString &txt)
const FXStringgetText () const
virtual void setIcon (FXIcon *icn)
FXIcongetIcon () 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 ()
virtual long onDefault (FXObject *, FXSelector, void *)
const FXchar * getClassName () const
bool isMemberOf (const FXMetaClass *metaclass) const
virtual long tryHandle (FXObject *sender, FXSelector sel, void *ptr)
QTransString tr (const char *text, const char *hint=0)
virtual void * getPythonObject () const
virtual void decouplePythonObject () const

Protected Member Functions

virtual void draw (const FXHeader *header, FXDC &dc, FXint x, FXint y, FXint w, FXint h)

Protected Attributes

FXString label
FXIconicon
void * data
FXint size
FXint pos
FXuint state

Friends

class FXHeader

Member Enumeration Documentation

anonymous enum

Enumerator:
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.

virtual long FX::FXObject::onDefault ( FXObject ,
FXSelector  ,
void *   
) [virtual, inherited]

Called for unhandled messages.

Reimplemented in FX::FXDelegator, FX::FXGLViewer, FX::FXMDIChild, and FX::FXMDIClient.

const FXchar* FX::FXObject::getClassName (  )  const [inherited]

Get class name of some object.

bool FX::FXObject::isMemberOf ( const FXMetaClass metaclass  )  const [inherited]

Check if object is member of metaclass.

virtual long FX::FXObject::tryHandle ( FXObject sender,
FXSelector  sel,
void *  ptr 
) [virtual, inherited]

Try handle message safely.

QTransString FX::FXObject::tr ( const char *  text,
const char *  hint = 0 
) [inherited]

Returns a human translated version of the text to the locale language (warning: uses a virtual method call, so can't use before construction)

virtual void* FX::FXObject::getPythonObject (  )  const [inline, virtual, inherited]

Returns the python object representing this instance (if created in python).

virtual void FX::FXObject::decouplePythonObject (  )  const [inline, virtual, inherited]

Causes decoupling of python object from this object (deletes self).


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

(C) 2002-2008 Niall Douglas. Some parts (C) to assorted authors.
Generated on Fri Jun 13 22:01:06 2008 for TnFOX by doxygen v1.5.6