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

FXDial Class Reference

#include <FXDial.h>

Inheritance diagram for FXDial:

FXFrame FXWindow FXDrawable FXId FXObject List of all members.

Public Methods

 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.

void setValue (FXint value)
 Set the dial value.

FXint getValue () const
 Return the dial value.

void setRange (FXint lo, FXint hi)
 Change the dial's range.

void getRange (FXint &lo, FXint &hi) const
 Obtain the current range of the dial.

void setRevolutionIncrement (FXint i)
FXint getRevolutionIncrement () const
 Get the current value of the revolution increment.

void setNotchSpacing (FXint spacing)
FXint getNotchSpacing () const
 Get the current notch spacing.

void setNotchOffset (FXint offset)
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.

void setTipText (const FXString &text)
 Set the tip text to be displayed in the tooltip.

virtual void save (FXStream &store) const
 Save to stream.

virtual void load (FXStream &store)
 Load from stream.


Public Attributes

FXString getHelpText () const
 Get the current help text.

FXString getTipText () const
 Get the current tooltip text value.


Detailed Description

The dial widget is a valuator widget which is able to provide a cyclic value range, or a simple linear value range. Optionally, the zero point may be displayed by means of a colored notch. 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.


Member Function Documentation

void FXDial::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

void FXDial::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

void FXDial::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]