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

Public Member Functions | List of all members
FX::FXButton Class Reference

#include <FXButton.h>

Inheritance diagram for FX::FXButton:
FX::FXLabel FX::FXFrame FX::FXWindow FX::FXDrawable FX::FXId FX::FXObject FX::FXMDIDeleteButton FX::FXMDIMaximizeButton FX::FXMDIMinimizeButton FX::FXMDIRestoreButton FX::FXPicker

Public Member Functions

 FXButton (FXComposite *p, const FXString &text, FXIcon *ic=NULL, FXObject *tgt=NULL, FXSelector sel=0, FXuint opts=BUTTON_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 bool canFocus () const
 
virtual void setFocus ()
 
virtual void killFocus ()
 
virtual void setDefault (FXbool enable=TRUE)
 
void setState (FXuint s)
 
FXuint getState () const
 
void setButtonStyle (FXuint style)
 
FXuint getButtonStyle () const
 
- Public Member Functions inherited from 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)
 
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 ()
 
- Public Member Functions inherited from 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)
 
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
 
- Public Member Functions inherited from FX::FXWindow
 FXWindow (FXComposite *p, FXuint opts=0, FXint x=0, FXint y=0, FXint w=0, FXint h=0)
 
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)
 
void setHelpTag (const FXString &text)
 
const FXString & getHelpTag () const
 
bool isShell () const
 
bool isOwnerOf (const FXWindow *window) const
 
bool isChildOf (const FXWindow *window) const
 
bool 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
 
FXComposeContext * getComposeContext () const
 
void createComposeContext ()
 
void destroyComposeContext ()
 
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)
 
bool isEnabled () const
 
bool isActive () const
 
bool hasFocus () const
 
bool inFocusChain () const
 
virtual void changeFocus (FXWindow *child)
 
bool isDefault () const
 
void setInitial (bool enable=true)
 
bool isInitial () const
 
virtual void attach (FXID w)
 
virtual void destroy ()
 
virtual void setShape (const FXRegion &region)
 
virtual void setShape (FXBitmap *bitmap)
 
virtual void setShape (FXIcon *icon)
 
virtual void clearShape ()
 
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 ()
 
virtual void layout ()
 
void forceRefresh ()
 
virtual void reparent (FXWindow *father, FXWindow *other=NULL)
 
void scroll (FXint x, FXint y, FXint w, FXint h, FXint dx, FXint dy) const
 
void update (FXint x, FXint y, FXint w, FXint h) const
 
void update () const
 
void repaint (FXint x, FXint y, FXint w, FXint h) const
 
void repaint () const
 
void grab ()
 
void ungrab ()
 
bool grabbed () const
 
void grabKeyboard ()
 
void ungrabKeyboard ()
 
bool grabbedKeyboard () const
 
virtual void show ()
 
virtual void hide ()
 
bool shown () const
 
virtual bool isComposite () const
 
bool underCursor () const
 
bool hasSelection () const
 
bool acquireSelection (const FXDragType *types, FXuint numtypes)
 
bool releaseSelection ()
 
bool hasClipboard () const
 
bool acquireClipboard (const FXDragType *types, FXuint numtypes)
 
bool releaseClipboard ()
 
virtual void dropEnable ()
 
virtual void dropDisable ()
 
bool isDropEnabled () const
 
bool isDragging () const
 
bool beginDrag (const FXDragType *types, FXuint numtypes)
 
bool handleDrag (FXint x, FXint y, FXDragAction action=DRAG_COPY)
 
FXDragAction endDrag (bool drop=true)
 
bool isDropTarget () const
 
void setDragRectangle (FXint x, FXint y, FXint w, FXint h, bool wantupdates=true) const
 
void clearDragRectangle () const
 
void acceptDrop (FXDragAction action=DRAG_ACCEPT) const
 
FXDragAction didAccept () const
 
void dropFinished (FXDragAction action=DRAG_REJECT) const
 
bool inquireDNDTypes (FXDNDOrigin origin, FXDragType *&types, FXuint &numtypes) const
 
bool offeredDNDType (FXDNDOrigin origin, FXDragType type) const
 
FXDragAction inquireDNDAction () const
 
bool setDNDData (FXDNDOrigin origin, FXDragType type, FXuchar *data, FXuint size) const
 
bool setDNDData (FXDNDOrigin origin, FXDragType type, const FXString &string) const
 
bool getDNDData (FXDNDOrigin origin, FXDragType type, FXuchar *&data, FXuint &size) const
 
bool getDNDData (FXDNDOrigin origin, FXDragType type, FXString &string) const
 
virtual bool 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
 
virtual bool doesSaveUnder () const
 
virtual const FXchar * tr (const FXchar *message, const FXchar *hint=NULL) const
 
virtual ~FXWindow ()
 
- Public Member Functions inherited from FX::FXDrawable
FXint getWidth () const
 
FXint getHeight () const
 
FXVisual * getVisual () const
 
void setVisual (FXVisual *vis)
 
virtual ~FXDrawable ()
 
- Public Member Functions inherited from FX::FXId
FXApp * getApp () const
 
FXID id () const
 
void setUserData (void *ptr)
 
void * getUserData () const
 
virtual ~FXId ()
 
- Public Member Functions inherited from FX::FXObject
virtual long onDefault (FXObject *, FXSelector, void *)
 
const FXchar * getClassName () const
 
bool isMemberOf (const FXMetaClass *metaclass) const
 
virtual long tryHandle (FXObject *sender, FXSelector sel, void *ptr)
 
virtual ~FXObject ()
 

Additional Inherited Members

- Public Types inherited from FX::FXWindow
enum  {
  ID_NONE,
  ID_HIDE,
  ID_SHOW,
  ID_TOGGLESHOWN,
  ID_LOWER,
  ID_RAISE,
  ID_DELETE,
  ID_DISABLE,
  ID_ENABLE,
  ID_TOGGLEENABLED,
  ID_UNCHECK,
  ID_CHECK,
  ID_UNKNOWN,
  ID_UPDATE,
  ID_AUTOSCROLL,
  ID_TIPTIMER,
  ID_HSCROLLED,
  ID_VSCROLLED,
  ID_SETVALUE,
  ID_SETINTVALUE,
  ID_SETREALVALUE,
  ID_SETSTRINGVALUE,
  ID_SETICONVALUE,
  ID_SETINTRANGE,
  ID_SETREALRANGE,
  ID_GETINTVALUE,
  ID_GETREALVALUE,
  ID_GETSTRINGVALUE,
  ID_GETICONVALUE,
  ID_GETINTRANGE,
  ID_GETREALRANGE,
  ID_SETHELPSTRING,
  ID_GETHELPSTRING,
  ID_SETTIPSTRING,
  ID_GETTIPSTRING,
  ID_QUERY_MENU,
  ID_HOTKEY,
  ID_ACCEL,
  ID_UNPOST,
  ID_POST,
  ID_MDI_TILEHORIZONTAL,
  ID_MDI_TILEVERTICAL,
  ID_MDI_CASCADE,
  ID_MDI_MAXIMIZE,
  ID_MDI_MINIMIZE,
  ID_MDI_RESTORE,
  ID_MDI_CLOSE,
  ID_MDI_WINDOW,
  ID_MDI_MENUWINDOW,
  ID_MDI_MENUMINIMIZE,
  ID_MDI_MENURESTORE,
  ID_MDI_MENUCLOSE,
  ID_MDI_NEXT,
  ID_MDI_PREV,
  ID_LAST
}
 
- Static Public Member Functions inherited from FX::FXWindow
static FXWindow * commonAncestor (FXWindow *a, FXWindow *b)
 
static bool before (const FXWindow *a, const FXWindow *b)
 
static bool after (const FXWindow *a, const FXWindow *b)
 
- Static Public Attributes inherited from FX::FXWindow
static FXDragType octetType
 
static FXDragType deleteType
 
static FXDragType textType
 
static FXDragType utf8Type
 
static FXDragType utf16Type
 
static FXDragType colorType
 
static FXDragType urilistType
 
static const FXDragType stringType
 
static const FXDragType imageType
 
static const FXchar octetTypeName []
 
static const FXchar deleteTypeName []
 
static const FXchar textTypeName []
 
static const FXchar colorTypeName []
 
static const FXchar urilistTypeName []
 
static const FXchar utf8TypeName []
 
static const FXchar utf16TypeName []
 

Detailed Description

A button provides a push button, with optional icon and/or text label.

When pressed, the button widget sends a SEL_COMMAND to its target. Passing the BUTTON_TOOLBAR style option gives buttons a "flat" look, and causes the edge of the button to be raised when the cursor moves over it. Passing BUTTON_DEFAULT allows the button to become the default button in a dialog, when the focus moves to it. The default widget in a dialog is the widget which will accept the RETURN key when it is pressed. The BUTTON_INITIAL flag makes the button the default widget when the focus moves to a widget which can not itself be a default widget. There should be only a single button in the dialog which is the initial default; typically this is the OK or CLOSE button. The option BUTTON_AUTOGRAY (BUTTON_AUTOHIDE) causes the button to be grayed out (hidden) if its handler does not respond to the SEL_UPDATE message. This is useful when messages are delegated, for example when using a multiple document interface, where the ultimaye destination of a message can be changed.

See also:

Constructor & Destructor Documentation

FX::FXButton::FXButton ( FXComposite *  p,
const FXString &  text,
FXIcon *  ic = NULL,
FXObject *  tgt = NULL,
FXSelector  sel = 0,
FXuint  opts = BUTTON_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 button with text and icon.

Member Function Documentation

virtual bool FX::FXButton::canFocus ( ) const
virtual

Returns true because a button can receive focus.

Reimplemented from FX::FXWindow.

virtual void FX::FXButton::setFocus ( )
virtual

Move the focus to this window.

Reimplemented from FX::FXWindow.

virtual void FX::FXButton::killFocus ( )
virtual

Remove the focus from this window.

Reimplemented from FX::FXWindow.

virtual void FX::FXButton::setDefault ( FXbool  enable = TRUE)
virtual

Set as default button.

Reimplemented from FX::FXWindow.

void FX::FXButton::setState ( FXuint  s)

Set the button state.

FXuint FX::FXButton::getState ( ) const
inline

Get the button state.

void FX::FXButton::setButtonStyle ( FXuint  style)

Set the button style flags.

FXuint FX::FXButton::getButtonStyle ( ) const

Get the button style flags.

Copyright © 1997-2005 Jeroen van der Zijp