FX::FXFrame Class Reference

The Frame widget provides borders around some contents. More...

#include <FXFrame.h>

Inheritance diagram for FX::FXFrame:

List of all members.

Public Member Functions
	FXFrame (FXComposite *p, FXuint opts=FRAME_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 FXint	getDefaultWidth ()
virtual FXint	getDefaultHeight ()
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
virtual void	save (FXStream &store) const
virtual void	load (FXStream &store)

---

Detailed Description

The Frame widget provides borders around some contents.

Borders may be raised, sunken, thick, ridged or etched. They can also be turned off completely. In addition, a certain amount of padding may be specified between the contents of the widget and the borders. The contents may be justified inside the widget using the justification options. The Frame widget is sometimes used by itself as a place holder, but most often is used as a convenient base class for simple controls.

See also:

• Justification modes used by certain subclasses.
• Default padding.

---

Constructor & Destructor Documentation

FX::FXFrame::FXFrame (  FXComposite *  p, FXuint  opts = FRAME_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 frame window.

---

Member Function Documentation

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

Return default width. Reimplemented from FX::FXWindow. Reimplemented in FX::FX7Segment, FX::FXArrowButton, FX::FXBitmapFrame, FX::FXCheckButton, FX::FXColorBar, FX::FXColorWell, FX::FXColorWheel, FX::FXDial, FX::FXDockTitle, FX::FXGradientBar, FX::FXHeader, FX::FXImageFrame, FX::FXLabel, FX::FXMDIDeleteButton, FX::FXMDIRestoreButton, FX::FXMDIMaximizeButton, FX::FXMDIMinimizeButton, FX::FXMDIWindowButton, FX::FXMenuButton, FX::FXOption, FX::FXOptionMenu, FX::FXProgressBar, FX::FXRadioButton, FX::FXRealSlider, FX::FXRuler, FX::FXSeparator, FX::FXSlider, FX::FXStatusLine, FX::FXTextField, FX::FXToggleButton, FX::FXToolBarGrip, FX::FXToolBarTab, and FX::FXTriStateButton.

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

Return default height. Reimplemented from FX::FXWindow. Reimplemented in FX::FX7Segment, FX::FXArrowButton, FX::FXBitmapFrame, FX::FXCheckButton, FX::FXColorBar, FX::FXColorWell, FX::FXColorWheel, FX::FXDial, FX::FXDockTitle, FX::FXGradientBar, FX::FXHeader, FX::FXImageFrame, FX::FXLabel, FX::FXMDIDeleteButton, FX::FXMDIRestoreButton, FX::FXMDIMaximizeButton, FX::FXMDIMinimizeButton, FX::FXMDIWindowButton, FX::FXMenuButton, FX::FXOption, FX::FXOptionMenu, FX::FXProgressBar, FX::FXRadioButton, FX::FXRealSlider, FX::FXRuler, FX::FXSeparator, FX::FXSlider, FX::FXStatusLine, FX::FXTextField, FX::FXToggleButton, FX::FXToolBarGrip, FX::FXToolBarTab, and FX::FXTriStateButton.

void FX::FXFrame::setFrameStyle (  FXuint  style  )

Change frame style.

FXuint FX::FXFrame::getFrameStyle (   )  const

Get current frame style.

FXint FX::FXFrame::getBorderWidth (   )  const [inline]

Get border width.

void FX::FXFrame::setPadTop (  FXint  pt  )

Change top padding.

FXint FX::FXFrame::getPadTop (   )  const [inline]

Get top interior padding.

void FX::FXFrame::setPadBottom (  FXint  pb  )

Change bottom padding.

FXint FX::FXFrame::getPadBottom (   )  const [inline]

Get bottom interior padding.

void FX::FXFrame::setPadLeft (  FXint  pl  )

Change left padding.

FXint FX::FXFrame::getPadLeft (   )  const [inline]

Get left interior padding.

void FX::FXFrame::setPadRight (  FXint  pr  )

Change right padding.

FXint FX::FXFrame::getPadRight (   )  const [inline]

Get right interior padding.

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

Change highlight color.

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

Get highlight color.

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

Change shadow color.

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

Get shadow color.

void FX::FXFrame::setBorderColor (  FXColor  clr  )

Change border color.

FXColor FX::FXFrame::getBorderColor (   )  const [inline]

Get border color.

void FX::FXFrame::setBaseColor (  FXColor  clr  )

Change base gui color.

FXColor FX::FXFrame::getBaseColor (   )  const [inline]

Get base gui color.

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

Save to stream. Reimplemented from FX::FXWindow. Reimplemented in FX::FX7Segment, FX::FXArrowButton, FX::FXBitmapFrame, FX::FXCheckButton, FX::FXColorBar, FX::FXColorWell, FX::FXColorWheel, FX::FXDial, FX::FXDockHandler, FX::FXDockTitle, FX::FXGradientBar, FX::FXHeader, FX::FXImageFrame, FX::FXLabel, FX::FXMenuButton, FX::FXOptionMenu, FX::FXProgressBar, FX::FXRadioButton, FX::FXRealSlider, FX::FXRuler, FX::FXSlider, FX::FXStatusLine, FX::FXTextField, FX::FXToggleButton, FX::FXToolBarGrip, FX::FXToolBarTab, and FX::FXTriStateButton.

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

Load from stream. Reimplemented from FX::FXWindow. Reimplemented in FX::FX7Segment, FX::FXArrowButton, FX::FXBitmapFrame, FX::FXCheckButton, FX::FXColorBar, FX::FXColorWell, FX::FXColorWheel, FX::FXDial, FX::FXDockHandler, FX::FXDockTitle, FX::FXGradientBar, FX::FXHeader, FX::FXImageFrame, FX::FXLabel, FX::FXMenuButton, FX::FXOptionMenu, FX::FXProgressBar, FX::FXRadioButton, FX::FXRealSlider, FX::FXRuler, FX::FXSlider, FX::FXStatusLine, FX::FXTextField, FX::FXToggleButton, FX::FXToolBarGrip, FX::FXToolBarTab, and FX::FXTriStateButton.

Copyright © 1997-2005 Jeroen van der Zijp