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

FX::FXKnob Class Reference

#include <FXKnob.h>

Inheritance diagram for FX::FXKnob:
FX::FXFrame FX::FXWindow FX::FXDrawable FX::FXId FX::FXObject

Public Types

enum  {
  ID_AUTOSLIDE =FXFrame::ID_LAST,
  ID_LAST
}
 
- 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
}
 

Public Member Functions

 FXKnob (FXComposite *p, FXObject *tgt=NULL, FXSelector sel=0, FXuint opts=KNOB_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 FXint getDefaultWidth ()
 
virtual FXint getDefaultHeight ()
 
virtual void layout ()
 
virtual void enable ()
 
virtual void disable ()
 
void setValue (FXint value, FXbool notify=FALSE)
 
FXint getValue () const
 
void setRange (FXint lo, FXint hi, FXbool notify=FALSE)
 
void getRange (FXint &lo, FXint &hi) const
 
void setLimits (FXint start, FXint end, FXbool notify=FALSE)
 
void getLimits (FXint &start, FXint &end)
 
FXuint getKnobStyle () const
 
void setKnobStyle (FXuint style)
 
FXint getIncrement () const
 
void setIncrement (FXint inc)
 
void setTickDelta (FXint dist)
 
FXint getTickDelta () const
 
void setLineColor (FXColor clr)
 
FXColor getLineColor () const
 
void setHelpText (const FXString &text)
 
const FXStringgetHelpText () const
 
void setTipText (const FXString &text)
 
const FXStringgetTipText () const
 
virtual void save (FXStream &store) const
 
virtual void load (FXStream &store)
 
virtual ~FXKnob ()
 
- 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)
 
FXWindowgetParent () const
 
FXWindowgetOwner () const
 
FXWindowgetShell () const
 
FXWindowgetRoot () const
 
FXWindowgetNext () const
 
FXWindowgetPrev () const
 
FXWindowgetFirst () const
 
FXWindowgetLast () const
 
FXWindowgetFocus () const
 
void setKey (FXuint k)
 
FXuint getKey () const
 
void setTarget (FXObject *t)
 
FXObjectgetTarget () 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
 
FXAccelTablegetAccelTable () const
 
void setAccelTable (FXAccelTable *acceltable)
 
void addHotKey (FXHotKey code)
 
void remHotKey (FXHotKey code)
 
void setHelpTag (const FXString &text)
 
const FXStringgetHelpTag () const
 
bool isShell () const
 
bool isOwnerOf (const FXWindow *window) const
 
bool isChildOf (const FXWindow *window) const
 
bool containsChild (const FXWindow *child) const
 
FXWindowgetChildAt (FXint x, FXint y) const
 
FXint numChildren () const
 
FXint indexOfChild (const FXWindow *window) const
 
FXWindowchildAtIndex (FXint index) const
 
FXComposeContextgetComposeContext () const
 
void createComposeContext ()
 
void destroyComposeContext ()
 
void setDefaultCursor (FXCursor *cur)
 
FXCursorgetDefaultCursor () const
 
void setDragCursor (FXCursor *cur)
 
FXCursorgetDragCursor () 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 setFocus ()
 
virtual void killFocus ()
 
virtual void changeFocus (FXWindow *child)
 
virtual void setDefault (FXbool enable=TRUE)
 
bool isDefault () const
 
void setInitial (bool enable=true)
 
bool isInitial () const
 
virtual void create ()
 
virtual void attach (FXID w)
 
virtual void detach ()
 
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 ()
 
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 FXchartr (const FXchar *message, const FXchar *hint=NULL) const
 
virtual ~FXWindow ()
 
- Public Member Functions inherited from FX::FXDrawable
FXint getWidth () const
 
FXint getHeight () const
 
FXVisualgetVisual () const
 
void setVisual (FXVisual *vis)
 
virtual ~FXDrawable ()
 
- Public Member Functions inherited from FX::FXId
FXAppgetApp () 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 FXchargetClassName () const
 
bool isMemberOf (const FXMetaClass *metaclass) const
 
virtual long tryHandle (FXObject *sender, FXSelector sel, void *ptr)
 
virtual ~FXObject ()
 

Additional Inherited Members

- Static Public Member Functions inherited from FX::FXWindow
static FXWindowcommonAncestor (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

The knob widget is a valuator widget which provides simple linear value range.

While being moved, the knob sends SEL_CHANGED messages to its target; at the end of the interaction, a final SEL_COMMAND message is sent. The message data represents the current knob value, of type FXint.

See also:

Member Enumeration Documentation

anonymous enum
Enumerator
ID_AUTOSLIDE 
ID_LAST 

Constructor & Destructor Documentation

FX::FXKnob::FXKnob ( FXComposite p,
FXObject tgt = NULL,
FXSelector  sel = 0,
FXuint  opts = KNOB_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 a knob widget.

virtual FX::FXKnob::~FXKnob ( )
virtual

Destroy the knob.

Member Function Documentation

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

Returns true because a knob can receive focus.

Reimplemented from FX::FXWindow.

virtual FXint FX::FXKnob::getDefaultWidth ( )
virtual

Return default width.

Reimplemented from FX::FXFrame.

virtual FXint FX::FXKnob::getDefaultHeight ( )
virtual

Return default height.

Reimplemented from FX::FXFrame.

virtual void FX::FXKnob::layout ( )
virtual

Perform layout.

Reimplemented from FX::FXWindow.

virtual void FX::FXKnob::enable ( )
virtual

Enable the knob.

Reimplemented from FX::FXWindow.

virtual void FX::FXKnob::disable ( )
virtual

Disable the knob.

Reimplemented from FX::FXWindow.

void FX::FXKnob::setValue ( FXint  value,
FXbool  notify = FALSE 
)

Change knob value.

FXint FX::FXKnob::getValue ( ) const
inline

Return knob value.

void FX::FXKnob::setRange ( FXint  lo,
FXint  hi,
FXbool  notify = FALSE 
)

Change the knob's range.

void FX::FXKnob::getRange ( FXint lo,
FXint hi 
) const
inline

Get the knob's current range.

void FX::FXKnob::setLimits ( FXint  start,
FXint  end,
FXbool  notify = FALSE 
)

Change the knob's movement limits (start and ending angles) accept values in degrees from 0 (south) to 360.

void FX::FXKnob::getLimits ( FXint start,
FXint end 
)

Get the knob's current limits.

FXuint FX::FXKnob::getKnobStyle ( ) const

Change the knob style.

void FX::FXKnob::setKnobStyle ( FXuint  style)

Get the current knob style.

FXint FX::FXKnob::getIncrement ( ) const
inline

Get the knob's auto-increment/decrement value.

void FX::FXKnob::setIncrement ( FXint  inc)
inline

Change the knob's auto-increment/decrement value.

void FX::FXKnob::setTickDelta ( FXint  dist)

Change the delta between ticks.

FXint FX::FXKnob::getTickDelta ( ) const
inline

Get delta between ticks.

void FX::FXKnob::setLineColor ( FXColor  clr)

Change the indicator needle color.

FXColor FX::FXKnob::getLineColor ( ) const
inline

Get the current indicator needle color.

void FX::FXKnob::setHelpText ( const FXString text)
inline

Set the help text to be displayed on the status line.

const FXString& FX::FXKnob::getHelpText ( ) const
inline

Get the current help text.

void FX::FXKnob::setTipText ( const FXString text)
inline

Set the tip text to be displayed in the tooltip.

const FXString& FX::FXKnob::getTipText ( ) const
inline

Get the current tooltip text value.

virtual void FX::FXKnob::save ( FXStream store) const
virtual

Save to stream.

Reimplemented from FX::FXFrame.

virtual void FX::FXKnob::load ( FXStream store)
virtual

Load from stream.

Reimplemented from FX::FXFrame.

Copyright © 1997-2005 Jeroen van der Zijp