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

FX::FXMenuCaption

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

 FXMenuCaption (FXComposite *p, const FXString &text, FXIcon *ic=NULL, FXuint opts=0)
virtual void create ()
virtual void detach ()
virtual void enable ()
virtual void disable ()
virtual FXint getDefaultWidth ()
virtual FXint getDefaultHeight ()
void setText (const FXString &text)
FXString getText () const
void setIcon (FXIcon *ic)
FXIcon * getIcon () const
void setFont (FXFont *fnt)
FXFont * getFont () const
void setMenuStyle (FXuint style)
FXuint getMenuStyle () const
void setTextColor (FXColor clr)
FXColor getTextColor () const
void setSelBackColor (FXColor clr)
FXColor getSelBackColor () const
void setSelTextColor (FXColor clr)
FXColor getSelTextColor () const
void setHiliteColor (FXColor clr)
FXColor getHiliteColor () const
void setShadowColor (FXColor clr)
FXColor getShadowColor () const
void setHelpText (const FXString &text)
const FXString & getHelpText () const
void setTipText (const FXString &text)
const FXString & getTipText () const
virtual void save (FXStream &store) const
virtual void load (FXStream &store)
virtual ~FXMenuCaption ()

Detailed Description

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

See also:

Constructor & Destructor Documentation

FX::FXMenuCaption::FXMenuCaption (  FXComposite *  p,
const FXString &  text,
FXIcon *  ic = NULL,
FXuint  opts = 0
) 
 

Construct a menu caption.

virtual FX::FXMenuCaption::~FXMenuCaption (   )  [virtual]
 

Destructor.

Member Function Documentation

virtual void FX::FXMenuCaption::create (   )  [virtual]
 

Create server-side resources.

Reimplemented from FX::FXWindow.

Reimplemented in FX::FXMenuCascade, and FX::FXMenuTitle.

virtual void FX::FXMenuCaption::detach (   )  [virtual]
 

Detach server-side resources.

Reimplemented from FX::FXWindow.

Reimplemented in FX::FXMenuCascade, and FX::FXMenuTitle.

virtual void FX::FXMenuCaption::enable (   )  [virtual]
 

Enable the menu.

Reimplemented from FX::FXWindow.

virtual void FX::FXMenuCaption::disable (   )  [virtual]
 

Disable the menu.

Reimplemented from FX::FXWindow.

virtual FXint FX::FXMenuCaption::getDefaultWidth (   )  [virtual]
 

Return default width.

Reimplemented from FX::FXWindow.

Reimplemented in FX::FXMenuCheck, FX::FXMenuCommand, FX::FXMenuRadio, and FX::FXMenuTitle.

virtual FXint FX::FXMenuCaption::getDefaultHeight (   )  [virtual]
 

Return default height.

Reimplemented from FX::FXWindow.

Reimplemented in FX::FXMenuCheck, FX::FXMenuCommand, FX::FXMenuRadio, and FX::FXMenuTitle.

void FX::FXMenuCaption::setText (  const FXString &  text  ) 
 

Set the text for this menu.

FXString FX::FXMenuCaption::getText (   )  const [inline]
 

Get the text for this menu.

void FX::FXMenuCaption::setIcon (  FXIcon *  ic  ) 
 

Set the icon for this menu.

FXIcon* FX::FXMenuCaption::getIcon (   )  const [inline]
 

Get the icon for this menu.

void FX::FXMenuCaption::setFont (  FXFont *  fnt  ) 
 

Set the text font.

FXFont* FX::FXMenuCaption::getFont (   )  const [inline]
 

Return the text font.

void FX::FXMenuCaption::setMenuStyle (  FXuint  style  ) 
 

Set menu caption style.

FXuint FX::FXMenuCaption::getMenuStyle (   )  const
 

Get menu caption style.

void FX::FXMenuCaption::setTextColor (  FXColor  clr  ) 
 

Return the current text color.

FXColor FX::FXMenuCaption::getTextColor (   )  const [inline]
 

Get the current text color.

void FX::FXMenuCaption::setSelBackColor (  FXColor  clr  ) 
 

Return the selection background color.

FXColor FX::FXMenuCaption::getSelBackColor (   )  const [inline]
 

Return the selection background color.

void FX::FXMenuCaption::setSelTextColor (  FXColor  clr  ) 
 

Return the selection text color.

FXColor FX::FXMenuCaption::getSelTextColor (   )  const [inline]
 

Return the selection text color.

void FX::FXMenuCaption::setHiliteColor (  FXColor  clr  ) 
 

Change highlight color.

FXColor FX::FXMenuCaption::getHiliteColor (   )  const [inline]
 

Get highlight color.

void FX::FXMenuCaption::setShadowColor (  FXColor  clr  ) 
 

Change shadow color.

FXColor FX::FXMenuCaption::getShadowColor (   )  const [inline]
 

Get shadow color.

void FX::FXMenuCaption::setHelpText (  const FXString &  text  ) 
 

Set the status line help text for this menu.

const FXString& FX::FXMenuCaption::getHelpText (   )  const [inline]
 

Get the status line help text for this menu.

void FX::FXMenuCaption::setTipText (  const FXString &  text  )  [inline]
 

Set the tool tip message for this menu.

const FXString& FX::FXMenuCaption::getTipText (   )  const [inline]
 

Get the tool tip message for this menu.

virtual void FX::FXMenuCaption::save (  FXStream &  store  )  const [virtual]
 

Save menu to a stream.

Reimplemented from FX::FXWindow.

Reimplemented in FX::FXMenuCascade, FX::FXMenuCheck, FX::FXMenuCommand, FX::FXMenuRadio, and FX::FXMenuTitle.

virtual void FX::FXMenuCaption::load (  FXStream &  store  )  [virtual]
 

Load menu from a stream.

Reimplemented from FX::FXWindow.

Reimplemented in FX::FXMenuCascade, FX::FXMenuCheck, FX::FXMenuCommand, FX::FXMenuRadio, and FX::FXMenuTitle.

Copyright © 1997-2005 Jeroen van der Zijp