class FXHeader

Header control may be placed over a table or list to provide a resizable captions above a number of columns.

Inheritance:

Public Methods

FXHeader(FXComposite* p, FXObject* tgt=NULL, FXSelector sel=0, FXuint opts=HEADER_NORMAL, FXint x=0, FXint y=0, FXint w=0, FXint h=0, FXint pl=DEFAULT_PAD, FXint pr=DEFAULT_PAD, FXint pt=DEFAULT_PAD, FXint pb=DEFAULT_PAD)

Construct new header control

virtual void create()

Create server-side resources

virtual void detach()

Detach server-side resources

FXint getNumItems() const

Return number of items

virtual FXint getDefaultWidth()

Return default width

virtual FXint getDefaultHeight()

Return default height

FXHeaderItem* retrieveItem(FXint index) const

Return item at given index

FXint replaceItem(FXint index, FXHeaderItem* item, FXbool notify=FALSE)

Replace the item with a [possibly subclassed] item

FXint replaceItem(FXint index, const FXString& text, FXIcon* icon=NULL, FXint size=0, void* ptr=NULL, FXbool notify=FALSE)

Replace items text, icon, and user-data pointer

FXint insertItem(FXint index, FXHeaderItem* item, FXbool notify=FALSE)

Insert a new [possibly subclassed] item at the give index

FXint insertItem(FXint index, const FXString& text, FXIcon* icon=NULL, FXint size=0, void* ptr=NULL, FXbool notify=FALSE)

Insert item at index with given text, icon, and user-data pointer

FXint appendItem(FXHeaderItem* item, FXbool notify=FALSE)

Append a [possibly subclassed] item to the list

FXint appendItem(const FXString& text, FXIcon* icon=NULL, FXint size=0, void* ptr=NULL, FXbool notify=FALSE)

Append new item with given text and optional icon, and user-data pointer

FXint prependItem(FXHeaderItem* item, FXbool notify=FALSE)

Prepend a [possibly subclassed] item to the list

FXint prependItem(const FXString& text, FXIcon* icon=NULL, FXint size=0, void* ptr=NULL, FXbool notify=FALSE)

Prepend new item with given text and optional icon, and user-data pointer

void removeItem(FXint index, FXbool notify=FALSE)

Remove item at index

void clearItems(FXbool notify=FALSE)

Remove all items

FXint getItemAt(FXint offset) const

Return item-index given pixel-offset from left

void setItemText(FXint index, const FXString& text)

Change text label for item at index

FXString getItemText(FXint index) const

Get text of item at index

void setItemIcon(FXint index, FXIcon* icon)

Change icon of item at index

FXIcon* getItemIcon(FXint index) const

Return icon of item at index

void setItemSize(FXint index, FXint size)

Change size of item at index

FXint getItemSize(FXint index) const

Return size of item at index

FXint getItemOffset(FXint index) const

Compute offset from the left side of item at index

void setItemData(FXint index, void* ptr)

Change data of item at index

void* getItemData(FXint index) const

Return data of item at index

void setArrowDir(FXint index, FXbool dir=MAYBE)

Change sort direction (FALSE, TRUE, MAYBE)

FXbool getArrowDir(FXint index) const

Return sort direction (FALSE, TRUE, MAYBE)

void setFont(FXFont* fnt)

Change text font

FXFont* getFont() const

return text font

FXColor getTextColor() const

Return text color

void setTextColor(FXColor clr)

Change text color

void setHeaderStyle(FXuint style)

Set header style options

FXuint getHeaderStyle() const

Get header style options

void setHelpText(const FXString& text)

Set the status line help text for this header

FXString getHelpText() const

Get the status line help text for this header

virtual void save(FXStream& store) const

Save header to a stream

virtual void load(FXStream& store)

Load header from a stream

virtual ~FXHeader()

Destructor

Inherited from FXFrame:

Public Methods

void setFrameStyle(FXuint style)

FXuint getFrameStyle() const

FXint getBorderWidth() const

void setPadTop(FXint pt)

FXint getPadTop() const

void setPadBottom(FXint pb)

FXint getPadBottom() const

void setPadLeft(FXint pl)

FXint getPadLeft() const

void setPadRight(FXint pr)

FXint getPadRight() const

void setHiliteColor(FXColor clr)

FXColor getHiliteColor() const

void setShadowColor(FXColor clr)

FXColor getShadowColor() const

void setBorderColor(FXColor clr)

FXColor getBorderColor() const

void setBaseColor(FXColor clr)

FXColor getBaseColor() const

Inherited from FXWindow:

Public Methods

FXWindow* getParent() const

FXWindow* getOwner() const

FXWindow* getShell() const

FXWindow* getRoot() const

FXWindow* getNext() const

FXWindow* getPrev() const

FXWindow* getFirst() const

FXWindow* getLast() const

FXWindow* getFocus() const

void setKey(FXuint k)

FXuint getKey() const

void setTarget(FXObject* t)

FXObject* getTarget() const

void setSelector(FXSelector sel)

FXSelector getSelector() const

FXint getX() const

FXint getY() const

virtual FXint getWidthForHeight(FXint givenheight)

virtual FXint getHeightForWidth(FXint givenwidth)

void setX(FXint x)

void setY(FXint y)

void setWidth(FXint w)

void setHeight(FXint h)

void setLayoutHints(FXuint lout)

FXuint getLayoutHints() const

FXAccelTable* getAccelTable() const

void setAccelTable(FXAccelTable* acceltable)

void addHotKey(FXHotKey code)

void remHotKey(FXHotKey code)

FXbool isShell() const

FXbool isChildOf(const FXWindow* window) const

FXbool containsChild(const FXWindow* child) const

FXWindow* getChildAt(FXint x, FXint y) const

FXint numChildren() const

FXint indexOfChild(const FXWindow* window) const

FXWindow* childAtIndex(FXint index) const

static FXWindow* commonAncestor(FXWindow* a, FXWindow* b)

void setDefaultCursor(FXCursor* cur)

FXCursor* getDefaultCursor() const

void setDragCursor(FXCursor* cur)

FXCursor* getDragCursor() const

FXint getCursorPosition(FXint& x, FXint& y, FXuint& buttons) const

FXint setCursorPosition(FXint x, FXint y)

FXbool isEnabled() const

FXbool isActive() const

virtual FXbool canFocus() const

FXbool hasFocus() const

virtual void setFocus()

virtual void killFocus()

virtual void setDefault(FXbool enable=TRUE)

FXbool isDefault() const

void setInitial(FXbool enable=TRUE)

FXbool isInitial() const

virtual void enable()

virtual void disable()

virtual void destroy()

virtual void raise()

virtual void lower()

virtual void move(FXint x, FXint y)

virtual void resize(FXint w, FXint h)

virtual void position(FXint x, FXint y, FXint w, FXint h)

virtual void recalc()

void forceRefresh()

virtual void reparent(FXWindow* newparent)

void scroll(FXint x, FXint y, FXint w, FXint h, FXint dx, FXint dy)

void update(FXint x, FXint y, FXint w, FXint h)

void update()

void repaint(FXint x, FXint y, FXint w, FXint h)

void repaint()

void grab()

void ungrab()

FXbool grabbed() const

void grabKeyboard()

void ungrabKeyboard()

FXbool grabbedKeyboard() const

virtual void show()

virtual void hide()

FXbool shown() const

virtual FXbool isComposite() const

FXbool underCursor() const

FXbool hasSelection() const

FXbool acquireSelection(const FXDragType* types, FXuint numtypes)

FXbool releaseSelection()

FXbool hasClipboard() const

FXbool acquireClipboard(const FXDragType* types, FXuint numtypes)

FXbool releaseClipboard()

void dropEnable()

void dropDisable()

FXbool isDropEnabled() const

FXbool isDragging() const

FXbool beginDrag(const FXDragType* types, FXuint numtypes)

FXbool handleDrag(FXint x, FXint y, FXDragAction action=DRAG_COPY)

FXbool endDrag(FXbool drop=TRUE)

FXbool isDropTarget() const

void setDragRectangle(FXint x, FXint y, FXint w, FXint h, FXbool wantupdates=TRUE)

void clearDragRectangle()

void acceptDrop(FXDragAction action=DRAG_ACCEPT)

FXDragAction didAccept() const

FXbool inquireDNDTypes(FXDNDOrigin origin, FXDragType*& types, FXuint& numtypes)

FXbool offeredDNDType(FXDNDOrigin origin, FXDragType type)

FXDragAction inquireDNDAction() const

FXbool setDNDData(FXDNDOrigin origin, FXDragType type, FXuchar* data, FXuint size)

FXbool getDNDData(FXDNDOrigin origin, FXDragType type, FXuchar*& data, FXuint& size)

virtual FXbool contains(FXint parentx, FXint parenty) const

void translateCoordinatesFrom(FXint& tox, FXint& toy, const FXWindow* fromwindow, FXint fromx, FXint fromy) const

void translateCoordinatesTo(FXint& tox, FXint& toy, const FXWindow* towindow, FXint fromx, FXint fromy) const

virtual void setBackColor(FXColor clr)

FXColor getBackColor() const

void linkBefore(FXWindow* sibling)

void linkAfter(FXWindow* sibling)

Inherited from FXDrawable:

Public Methods

FXint getWidth() const

FXint getHeight() const

FXVisual* getVisual() const

void setVisual(FXVisual* vis)

Inherited from FXId:

Public Methods

FXApp* getApp() const

FXID id() const

void setUserData(void* ptr)

void* getUserData() const

Inherited from FXObject:

Public Methods

const FXchar* getClassName() const

FXbool isMemberOf(const FXMetaClass* metaclass) const

Documentation

Header control may be placed over a table or list to provide a resizable captions above a number of columns. Each caption comprises a label and an optional icon; in addition, an arrow may be shown to indicate whether the items in that column are sorted, and if so, whether they are sorted in increasing or decreasing order. Each caption can be interactively resized. During the resizing, if the HEADER_TRACKING was specified, the header control sends a SEL_CHANGED message to its target, with the message data set to the caption number being resized, of the type FXint. If the HEADER_TRACKING was not specified the SEL_CHANGED message is sent at the end of the resizing operation. Clicking on a caption causes a message of type SEL_COMMAND to be sent to the target, with the message data set to the caption number being clicked.

FXHeader(FXComposite* p, FXObject* tgt=NULL, FXSelector sel=0, FXuint opts=HEADER_NORMAL, FXint x=0, FXint y=0, FXint w=0, FXint h=0, FXint pl=DEFAULT_PAD, FXint pr=DEFAULT_PAD, FXint pt=DEFAULT_PAD, FXint pb=DEFAULT_PAD)

Construct new header control

virtual void create()

Create server-side resources

virtual void detach()

Detach server-side resources

FXint getNumItems() const

Return number of items

virtual FXint getDefaultWidth()

Return default width

virtual FXint getDefaultHeight()

Return default height

FXHeaderItem* retrieveItem(FXint index) const

Return item at given index

FXint replaceItem(FXint index, FXHeaderItem* item, FXbool notify=FALSE)

Replace the item with a [possibly subclassed] item

FXint replaceItem(FXint index, const FXString& text, FXIcon* icon=NULL, FXint size=0, void* ptr=NULL, FXbool notify=FALSE)

Replace items text, icon, and user-data pointer

FXint insertItem(FXint index, FXHeaderItem* item, FXbool notify=FALSE)

Insert a new [possibly subclassed] item at the give index

FXint insertItem(FXint index, const FXString& text, FXIcon* icon=NULL, FXint size=0, void* ptr=NULL, FXbool notify=FALSE)

Insert item at index with given text, icon, and user-data pointer

FXint appendItem(FXHeaderItem* item, FXbool notify=FALSE)

Append a [possibly subclassed] item to the list

FXint appendItem(const FXString& text, FXIcon* icon=NULL, FXint size=0, void* ptr=NULL, FXbool notify=FALSE)

Append new item with given text and optional icon, and user-data pointer

FXint prependItem(FXHeaderItem* item, FXbool notify=FALSE)

Prepend a [possibly subclassed] item to the list

FXint prependItem(const FXString& text, FXIcon* icon=NULL, FXint size=0, void* ptr=NULL, FXbool notify=FALSE)

Prepend new item with given text and optional icon, and user-data pointer

void removeItem(FXint index, FXbool notify=FALSE)

Remove item at index

void clearItems(FXbool notify=FALSE)

Remove all items

FXint getItemAt(FXint offset) const

Return item-index given pixel-offset from left

void setItemText(FXint index, const FXString& text)

Change text label for item at index

FXString getItemText(FXint index) const

Get text of item at index

void setItemIcon(FXint index, FXIcon* icon)

Change icon of item at index

FXIcon* getItemIcon(FXint index) const

Return icon of item at index

void setItemSize(FXint index, FXint size)

Change size of item at index

FXint getItemSize(FXint index) const

Return size of item at index

FXint getItemOffset(FXint index) const

Compute offset from the left side of item at index

void setItemData(FXint index, void* ptr)

Change data of item at index

void* getItemData(FXint index) const

Return data of item at index

void setArrowDir(FXint index, FXbool dir=MAYBE)

Change sort direction (FALSE, TRUE, MAYBE)

FXbool getArrowDir(FXint index) const

Return sort direction (FALSE, TRUE, MAYBE)

void setFont(FXFont* fnt)

Change text font

FXFont* getFont() const

return text font

FXColor getTextColor() const

Return text color

void setTextColor(FXColor clr)

Change text color

void setHeaderStyle(FXuint style)

Set header style options

FXuint getHeaderStyle() const

Get header style options

void setHelpText(const FXString& text)

Set the status line help text for this header

FXString getHelpText() const

Get the status line help text for this header

virtual void save(FXStream& store) const

Save header to a stream

virtual void load(FXStream& store)

Load header from a stream

virtual ~FXHeader()

Destructor

This class has no child classes.

Alphabetic index HTML hierarchy of classes or Java