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

FX::FXDial Class Reference

The Dial widget is a valuator widget which is able to provide a cyclic value range when the DIAL_CYCLIC is passed, or a simple linear value range. More...

#include <FXDial.h>

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

List of all members.

Public Member Functions

long onPaint (FXObject *, FXSelector, void *)
long onMotion (FXObject *, FXSelector, void *)
long onMouseWheel (FXObject *, FXSelector, void *)
long onLeftBtnPress (FXObject *, FXSelector, void *)
long onLeftBtnRelease (FXObject *, FXSelector, void *)
long onKeyPress (FXObject *, FXSelector, void *)
long onKeyRelease (FXObject *, FXSelector, void *)
long onUngrabbed (FXObject *, FXSelector, void *)
long onCmdSetValue (FXObject *, FXSelector, void *)
long onCmdSetIntValue (FXObject *, FXSelector, void *)
long onCmdGetIntValue (FXObject *, FXSelector, void *)
long onCmdSetLongValue (FXObject *, FXSelector, void *)
long onCmdGetLongValue (FXObject *, FXSelector, void *)
long onCmdSetRealValue (FXObject *, FXSelector, void *)
long onCmdGetRealValue (FXObject *, FXSelector, void *)
long onCmdSetIntRange (FXObject *, FXSelector, void *)
long onCmdGetIntRange (FXObject *, FXSelector, void *)
long onCmdSetRealRange (FXObject *, FXSelector, void *)
long onCmdGetRealRange (FXObject *, FXSelector, void *)
long onCmdSetHelp (FXObject *, FXSelector, void *)
long onCmdGetHelp (FXObject *, FXSelector, void *)
long onCmdSetTip (FXObject *, FXSelector, void *)
long onCmdGetTip (FXObject *, FXSelector, void *)
long onQueryHelp (FXObject *, FXSelector, void *)
long onQueryTip (FXObject *, FXSelector, void *)
 FXDial (FXComposite *p, FXObject *tgt=NULL, FXSelector sel=0, FXuint opts=DIAL_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 dial widget.
virtual FXint getDefaultWidth ()
 Return default width.
virtual FXint getDefaultHeight ()
 Return default height.
virtual FXbool canFocus () const
 Returns true because a dial can receive focus.
void setValue (FXint value, FXbool notify=false)
 Set the dial value.
FXint getValue () const
 Return the dial value.
void setRange (FXint lo, FXint hi, FXbool notify=false)
 Change the dial's range.
void getRange (FXint &lo, FXint &hi) const
 Obtain the current range of the dial.
void setRevolutionIncrement (FXint i)
 Set the revolution increment, which is the amount of change in the position for revolution of the dial; the dial may go through multiple revolutions to go through its whole range; by default it takes one 360 degree turn of the dial to go from the lower to the upper range.
FXint getRevolutionIncrement () const
 Get the current value of the revolution increment.
void setNotchSpacing (FXint spacing)
 Change the spacing for the small notches; this should be set in tenths of degrees in the range [1,3600], and the value should be a divisor of 3600, so as to make the notches come out evenly.
FXint getNotchSpacing () const
 Get the current notch spacing.
void setNotchOffset (FXint offset)
 Change the notch offset, which is the position of the center notch; the value should be tenths of degrees in the range [-3600,3600].
FXint getNotchOffset () const
 Get the current center notch offset.
void setDialStyle (FXuint opts)
 Changes the dial style.
FXuint getDialStyle () const
 Get the current dial style.
void setNotchColor (FXColor clr)
 Change the center notch color.
FXColor getNotchColor () const
 Get the current center notch color.
void setHelpText (const FXString &text)
 Set the help text to be displayed on the status line.
const FXStringgetHelpText () const
 Get the current help text.
void setTipText (const FXString &text)
 Set the tip text to be displayed in the tooltip.
const FXStringgetTipText () const
 Get the current tooltip text value.
virtual void save (FXStream &store) const
 Save to stream.
virtual void load (FXStream &store)
 Load from stream.

Protected Attributes

FXint notchAngle
FXint notchSpacing
FXint notchOffset
FXColor notchColor
FXint dragPoint
FXint dragPos
FXint range [2]
FXint incr
FXint pos
FXString help
FXString tip

Detailed Description

The Dial widget is a valuator widget which is able to provide a cyclic value range when the DIAL_CYCLIC is passed, or a simple linear value range.

While being turned, the dial sends a SEL_CHANGED message to its target; at the end of the interaction, a SEL_COMMAND message is sent. The message data represents the current value, of type FXint. The options DIAL_VERTICAL and DIAL_HORIZONTAL control the orientation of the dial. An optional notch can be used to indicate the zero-position of the dial; display of the notch is controlled by the DIAL_HAS_NOTCH option.


The documentation for this class was generated from the following file:

Copyright © 1997-2011 Jeroen van der Zijp