Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members

FX::FXHeaderItem Class Reference

Header item. More...

#include <FXHeader.h>

Inheritance diagram for FX::FXHeaderItem:

Public Types

enum  {
  ARROW_NONE = 0, ARROW_UP = 0x00000001, ARROW_DOWN = 0x00000002, PRESSED = 0x00000004,
  ICONOWNED = 0x00000008, RIGHT = 0x00000010, LEFT = 0x00000020, CENTER_X = 0,
  TOP = 0x00000040, BOTTOM = 0x00000080, CENTER_Y = 0, BEFORE = 0x00000100,
  AFTER = 0x00000200, ABOVE = 0x00000400, BELOW = 0x00000800

Public Member Functions

 FXHeaderItem (const FXString &text, FXIcon *ic=nullptr, FXint s=0, void *ptr=nullptr)
 Construct new item with given text, icon, size, and user-data.
virtual void setText (const FXString &txt)
 Change item's text label.
const FXStringgetText () const
 Return item's text label.
void setTipText (const FXString &text)
 Set the tool tip message for this item.
const FXStringgetTipText () const
 Get the tool tip message for this item.
virtual void setIcon (FXIcon *icn, FXbool owned=false)
 Change item's icon, deleting the old icon if it was owned.
FXIcongetIcon () const
 Return item's icon.
void setData (void *ptr)
 Change item's user data.
void * getData () const
 Get item's user data.
void setSize (FXint s)
 Change size.
FXint getSize () const
 Obtain current size.
void setPos (FXint p)
 Change position.
FXint getPos () const
 Obtain current position.
void setArrowDir (FXuint dir=ARROW_NONE)
 Change sort direction (ARROW_NONE, ARROW_UP, ARROW_DOWN)
FXuint getArrowDir () const
 Return sort direction (ARROW_NONE, ARROW_UP, ARROW_DOWN)
void setJustify (FXuint justify=LEFT|CENTER_Y)
 Change content justification.
FXuint getJustify () const
 Return content justification.
void setIconPosition (FXuint mode=BEFORE)
 Change icon position.
FXuint getIconPosition () const
 Return icon position.
void setPressed (FXbool pressed)
 Change state to pressed.
FXbool isPressed () const
 Return pressed state.
virtual FXint getWidth (const FXHeader *header) const
 Return the item's content width in the header.
virtual FXint getHeight (const FXHeader *header) const
 Return the item's content height in the header.
virtual void create ()
 Create server-side resources.
virtual void detach ()
 Detach from server-side resources.
virtual void destroy ()
 Destroy server-side resources.
virtual void save (FXStream &store) const
 Stream serialization.
virtual void load (FXStream &store)
 Load object from stream.
virtual ~FXHeaderItem ()
 Delete item and free icon if owned.
- Public Member Functions inherited from FX::FXObject
const FXchar * getClassName () const
 Get class name of some object.
FXbool isMemberOf (const FXMetaClass *metaclass) const
 Check if object is member of metaclass.
virtual long tryHandle (FXObject *sender, FXSelector sel, void *ptr)
 Try handle message safely, catching certain exceptions.
virtual long onDefault (FXObject *, FXSelector, void *)
 Called for unhandled messages.
virtual ~FXObject ()
 Virtual destructor.

Protected Member Functions

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

Protected Attributes

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


class FXHeader

Detailed Description

Header item.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

No arrow.


Arrow pointing up.


Arrow pointing down.


Pressed down.


Icon owned by header item.


Align on right.


Align on left.


Aling centered horizontally (default)


Align on top.


Align on bottom.


Aling centered vertically (default)


Icon before the text.


Icon after the text.


Icon above the text.

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

Copyright © 1997-2022 Jeroen van der Zijp