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

FX::FXLabel

FX::FXLabel Class Reference

A label widget can be used to place a text and/or icon for explanation purposes. More...

#include <FXLabel.h>

Inheritance diagram for FX::FXLabel:

FX::FXFrame FX::FXWindow FX::FXDrawable FX::FXId FX::FXObject FX::FXButton FX::FXCheckButton FX::FXMenuButton FX::FXOption FX::FXOptionMenu FX::FXRadioButton FX::FXTabItem FX::FXToggleButton List of all members.

Public Member Functions

 FXLabel (FXComposite *p, const FXString &text, FXIcon *ic=0, FXuint opts=LABEL_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)
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
FXColor getTextColor () const
void setTextColor (FXColor clr)
void setJustify (FXuint mode)
FXuint getJustify () const
void setIconPosition (FXuint mode)
FXuint getIconPosition () 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 ~FXLabel ()

Detailed Description

A label widget can be used to place a text and/or icon for explanation purposes.

The text label may have an optional tooltip and/or help string. Icon and label are placed relative to the widget using the justfication options, and relative to each other as determined by the icon relationship options. A large number of arrangements is possible.

See also:

Constructor & Destructor Documentation

FX::FXLabel::FXLabel (  FXComposite *  p,
const FXString &  text,
FXIcon *  ic = 0,
FXuint  opts = LABEL_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 label with given text and icon.

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

Destructor.

Member Function Documentation

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

Create server-side resources.

Reimplemented from FX::FXWindow.

Reimplemented in FX::FXMenuButton, FX::FXOptionMenu, FX::FXToggleButton, and FX::FXTriStateButton.

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

Detach server-side resources.

Reimplemented from FX::FXWindow.

Reimplemented in FX::FXMenuButton, FX::FXOptionMenu, FX::FXToggleButton, and FX::FXTriStateButton.

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

Enable the window.

Reimplemented from FX::FXWindow.

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

Disable the window.

Reimplemented from FX::FXWindow.

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

Return default width.

Reimplemented from FX::FXFrame.

Reimplemented in FX::FXCheckButton, FX::FXMDIDeleteButton, FX::FXMDIRestoreButton, FX::FXMDIMaximizeButton, FX::FXMDIMinimizeButton, FX::FXMDIWindowButton, FX::FXMenuButton, FX::FXOption, FX::FXOptionMenu, FX::FXRadioButton, FX::FXToggleButton, and FX::FXTriStateButton.

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

Return default height.

Reimplemented from FX::FXFrame.

Reimplemented in FX::FXCheckButton, FX::FXMDIDeleteButton, FX::FXMDIRestoreButton, FX::FXMDIMaximizeButton, FX::FXMDIMinimizeButton, FX::FXMDIWindowButton, FX::FXMenuButton, FX::FXOption, FX::FXOptionMenu, FX::FXRadioButton, FX::FXToggleButton, and FX::FXTriStateButton.

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

Set the text for this label.

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

Get the text for this label.

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

Set the icon for this label.

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

Get the icon for this label.

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

Set the text font.

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

Get the text font.

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

Get the current text color.

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

Set the current text color.

void FX::FXLabel::setJustify (  FXuint  mode  ) 
 

Set the current text-justification mode.

FXuint FX::FXLabel::getJustify (   )  const
 

Get the current text-justification mode.

void FX::FXLabel::setIconPosition (  FXuint  mode  ) 
 

Set the current icon position.

FXuint FX::FXLabel::getIconPosition (   )  const
 

Get the current icon position.

void FX::FXLabel::setHelpText (  const FXString &  text  )  [inline]
 

Set the status line help text for this label.

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

Get the status line help text for this label.

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

Set the tool tip message for this label.

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

Get the tool tip message for this label.

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

Save label to a stream.

Reimplemented from FX::FXFrame.

Reimplemented in FX::FXCheckButton, FX::FXMenuButton, FX::FXOptionMenu, FX::FXRadioButton, FX::FXToggleButton, and FX::FXTriStateButton.

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

Load label from a stream.

Reimplemented from FX::FXFrame.

Reimplemented in FX::FXCheckButton, FX::FXMenuButton, FX::FXOptionMenu, FX::FXRadioButton, FX::FXToggleButton, and FX::FXTriStateButton.

Copyright © 1997-2005 Jeroen van der Zijp