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

FX::FXMenuCaption Class Reference

The menu caption is a widget which can be used as a caption above a number of menu commands in a menu. More...

#include <FXMenuCaption.h>

Inheritance diagram for FX::FXMenuCaption:
FX::FXWindow FX::FXDrawable FX::FXId FX::FXObject FX::FXMenuCascade FX::FXMenuCommand FX::FXMenuTitle FX::FXMenuCheck FX::FXMenuRadio

List of all members.

Public Member Functions

long onPaint (FXObject *, FXSelector, void *)
long onUpdate (FXObject *, FXSelector, void *)
long onCmdSetValue (FXObject *, FXSelector, void *)
long onCmdGetStringValue (FXObject *, FXSelector, void *)
long onCmdSetStringValue (FXObject *, FXSelector, void *)
long onCmdSetIconValue (FXObject *, FXSelector, void *)
long onCmdGetIconValue (FXObject *, FXSelector, void *)
long onCmdSetHelp (FXObject *, FXSelector, void *)
long onCmdGetHelp (FXObject *, FXSelector, void *)
long onCmdSetTip (FXObject *, FXSelector, void *)
long onCmdGetTip (FXObject *, FXSelector, void *)
long onQueryHelp (FXObject *, FXSelector, void *)
long onQueryTip (FXObject *, FXSelector, void *)
 FXMenuCaption (FXComposite *p, const FXString &text, FXIcon *ic=NULL, FXuint opts=0)
 Construct a menu caption.
virtual void create ()
 Create server-side resources.
virtual void detach ()
 Detach server-side resources.
virtual void enable ()
 Enable the menu.
virtual void disable ()
 Disable the menu.
virtual FXint getDefaultWidth ()
 Return default width.
virtual FXint getDefaultHeight ()
 Return default height.
void setText (const FXString &text)
 Set the text for this menu.
FXString getText () const
 Get the text for this menu.
void setIcon (FXIcon *ic)
 Set the icon for this menu.
FXIcongetIcon () const
 Get the icon for this menu.
void setFont (FXFont *fnt)
 Set the text font.
FXFontgetFont () const
 Return the text font.
void setMenuStyle (FXuint style)
 Set menu caption style.
FXuint getMenuStyle () const
 Get menu caption style.
void setTextColor (FXColor clr)
 Return the current text color.
FXColor getTextColor () const
 Get the current text color.
void setSelBackColor (FXColor clr)
 Return the selection background color.
FXColor getSelBackColor () const
 Return the selection background color.
void setSelTextColor (FXColor clr)
 Return the selection text color.
FXColor getSelTextColor () const
 Return the selection text color.
void setHiliteColor (FXColor clr)
 Change highlight color.
FXColor getHiliteColor () const
 Get highlight color.
void setShadowColor (FXColor clr)
 Change shadow color.
FXColor getShadowColor () const
 Get shadow color.
void setHelpText (const FXString &text)
 Set the status line help text for this menu.
const FXStringgetHelpText () const
 Get the status line help text for this menu.
void setTipText (const FXString &text)
 Set the tool tip message for this menu.
const FXStringgetTipText () const
 Get the tool tip message for this menu.
virtual void save (FXStream &store) const
 Save menu to a stream.
virtual void load (FXStream &store)
 Load menu from a stream.
virtual ~FXMenuCaption ()
 Destructor.

Protected Attributes

FXString label
FXString help
FXString tip
FXIconicon
FXFontfont
FXint hotoff
FXHotKey hotkey
FXColor textColor
FXColor selbackColor
FXColor seltextColor
FXColor hiliteColor
FXColor shadowColor

Detailed Description

The menu caption is a widget which can be used as a caption above a number of menu commands in a menu.

When passing a tab-separated list of fields in the text parameter, the caption text is set to the first field, and the help string to the third field. If the caption text contains an ampersand, the letter following it will be underlined, and a suitable hotkey will be installed. The actual ampersand will be removed. To display an ampersand in the caption, use two consecutive ampersands.


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

Copyright © 1997-2011 Jeroen van der Zijp