newspeoplefor developersdocumentationdownloads

Main Page Modules C++ Classes Compound List File List Index Related Pages

nGuiHoriSliderGroup Class Reference
[Graphical User Interface]

#include <nguihorislidergroup.h>

Inheritance diagram for nGuiHoriSliderGroup:

nGuiFormLayout nGuiWidget nRoot nObject nNode nReferenced nSignalEmitter List of all members.

Detailed Description

A horizontal slider group consisting of a label, a horizontal slider, and a text label which displays the current slider's numerical value as a printf-formatted string.

(C) 2004 RadonLabs GmbH

Definition at line 19 of file nguihorislidergroup.h.


Public Types

enum  DisplayFormat {
  Int,
  Float
}
 set the printf display format (default is Int) More...

Public Member Functions

 nGuiHoriSliderGroup ()
 constructor
virtual ~nGuiHoriSliderGroup ()
 destructor
void SetLabelFont (const char *f)
 set the label font
const char * GetLabelFont () const
 get the label font
void SetLeftText (const char *t)
 set text to left of slider (a printf formatted string)
const char * GetLeftText () const
 get text to left of slider
void SetRightText (const char *t)
 set text to right of slider (a printf formatted string)
const char * GetRightText () const
 get text to right of slider
void SetLeftWidth (float w)
 set relative width of left text label
float GetLeftWidth () const
 get relative width of left text label
void SetRightWidth (float w)
 set relative width of right text label
float GetRightWidth () const
 get relative width of right text label
void SetMinValue (float v)
 set the slider's minimum value
float GetMinValue () const
 get the slider's minimum value
void SetMaxValue (float v)
 set the slider's maximum value
float GetMaxValue () const
 get the slider's maximum value
void SetValue (float v)
 set the slider's current value
float GetValue () const
 get the slider's current value
void SetKnobSize (float s)
 set the knob size
float GetKnobSize () const
 get the knob size
void SetIncrement (float i)
 set increment value
float GetIncrement () const
 get increment value
void SetSnapToIncrement (bool b)
 set snap-to-increment flag
bool GetSnapToIncrement () const
 get snap-to-increment flag
void SetDisplayFormat (DisplayFormat f)
 set display format (default is Int)
DisplayFormat GetDisplayFormat () const
 get display format
virtual void OnShow ()
 called when widget is becoming visible
virtual void OnHide ()
 called when widget is becoming invisible
virtual void OnFrame ()
 called per frame when parent widget is visible
virtual void OnEvent (const nGuiEvent &event)
 notify widget of an event
virtual void SetLeftTextAlignment (nGuiTextLabel::Alignment a)
 set alignment of text in left label
virtual void SetRightTextAlignment (nGuiTextLabel::Alignment a)
 set alignment of text in right label
virtual nGuiSlider2 * GetSlider () const
 set alignment of text in right label

Protected Attributes

nString labelFont
nString leftText
nString rightText
DisplayFormat displayFormat
float leftWidth
float rightWidth
float minValue
float maxValue
float curValue
float knobSize
float increment
bool snapToIncrement
nGuiTextLabel::Alignment leftTextAlignment
nGuiTextLabel::Alignment rightTextAlignment
nRef< nGuiTextLabel > refLeftLabel
nRef< nGuiTextLabel > refRightLabel
nRef< nGuiSlider2 > refSlider

Member Enumeration Documentation

enum nGuiHoriSliderGroup::DisplayFormat
 

set the printf display format (default is Int)

Enumerator:
Int 
Float 

Definition at line 23 of file nguihorislidergroup.h.

Constructor & Destructor Documentation

nGuiHoriSliderGroup::nGuiHoriSliderGroup (   ) 
 

constructor

Definition at line 14 of file nguihorislidergroup_main.cc.

nGuiHoriSliderGroup::~nGuiHoriSliderGroup (   )  [virtual]
 

destructor

Definition at line 34 of file nguihorislidergroup_main.cc.

Member Function Documentation

void nGuiHoriSliderGroup::SetLabelFont (  const char *  f  )  [inline]
 

set the label font

Definition at line 181 of file nguihorislidergroup.h.

const char * nGuiHoriSliderGroup::GetLabelFont (   )  const [inline]
 

get the label font

Definition at line 192 of file nguihorislidergroup.h.

void nGuiHoriSliderGroup::SetLeftText (  const char *  t  )  [inline]
 

set text to left of slider (a printf formatted string)

Definition at line 242 of file nguihorislidergroup.h.

const char * nGuiHoriSliderGroup::GetLeftText (   )  const [inline]
 

get text to left of slider

Definition at line 252 of file nguihorislidergroup.h.

void nGuiHoriSliderGroup::SetRightText (  const char *  t  )  [inline]
 

set text to right of slider (a printf formatted string)

Definition at line 262 of file nguihorislidergroup.h.

const char * nGuiHoriSliderGroup::GetRightText (   )  const [inline]
 

get text to right of slider

Definition at line 272 of file nguihorislidergroup.h.

void nGuiHoriSliderGroup::SetLeftWidth (  float  w  )  [inline]
 

set relative width of left text label

Definition at line 202 of file nguihorislidergroup.h.

float nGuiHoriSliderGroup::GetLeftWidth (   )  const [inline]
 

get relative width of left text label

Definition at line 212 of file nguihorislidergroup.h.

void nGuiHoriSliderGroup::SetRightWidth (  float  w  )  [inline]
 

set relative width of right text label

Definition at line 222 of file nguihorislidergroup.h.

float nGuiHoriSliderGroup::GetRightWidth (   )  const [inline]
 

get relative width of right text label

Definition at line 232 of file nguihorislidergroup.h.

void nGuiHoriSliderGroup::SetMinValue (  float  v  )  [inline]
 

set the slider's minimum value

Definition at line 282 of file nguihorislidergroup.h.

float nGuiHoriSliderGroup::GetMinValue (   )  const [inline]
 

get the slider's minimum value

Definition at line 292 of file nguihorislidergroup.h.

void nGuiHoriSliderGroup::SetMaxValue (  float  v  )  [inline]
 

set the slider's maximum value

Definition at line 302 of file nguihorislidergroup.h.

float nGuiHoriSliderGroup::GetMaxValue (   )  const [inline]
 

get the slider's maximum value

Definition at line 312 of file nguihorislidergroup.h.

void nGuiHoriSliderGroup::SetValue (  float  v  )  [inline]
 

set the slider's current value

Definition at line 322 of file nguihorislidergroup.h.

float nGuiHoriSliderGroup::GetValue (   )  const [inline]
 

get the slider's current value

Definition at line 337 of file nguihorislidergroup.h.

void nGuiHoriSliderGroup::SetKnobSize (  float  s  )  [inline]
 

set the knob size

Definition at line 347 of file nguihorislidergroup.h.

float nGuiHoriSliderGroup::GetKnobSize (   )  const [inline]
 

get the knob size

Definition at line 357 of file nguihorislidergroup.h.

void nGuiHoriSliderGroup::SetIncrement (  float  i  )  [inline]
 

set increment value

Definition at line 141 of file nguihorislidergroup.h.

float nGuiHoriSliderGroup::GetIncrement (   )  const [inline]
 

get increment value

Definition at line 151 of file nguihorislidergroup.h.

void nGuiHoriSliderGroup::SetSnapToIncrement (  bool  b  )  [inline]
 

set snap-to-increment flag

Definition at line 121 of file nguihorislidergroup.h.

bool nGuiHoriSliderGroup::GetSnapToIncrement (   )  const [inline]
 

get snap-to-increment flag

Definition at line 131 of file nguihorislidergroup.h.

void nGuiHoriSliderGroup::SetDisplayFormat (  DisplayFormat  f  )  [inline]
 

set display format (default is Int)

Definition at line 161 of file nguihorislidergroup.h.

nGuiHoriSliderGroup::DisplayFormat nGuiHoriSliderGroup::GetDisplayFormat (   )  const [inline]
 

get display format

Definition at line 171 of file nguihorislidergroup.h.

void nGuiHoriSliderGroup::OnShow (   )  [virtual]
 

called when widget is becoming visible

Reimplemented from nGuiWidget.

Definition at line 43 of file nguihorislidergroup_main.cc.

void nGuiHoriSliderGroup::OnHide (   )  [virtual]
 

called when widget is becoming invisible

Reimplemented from nGuiWidget.

Definition at line 111 of file nguihorislidergroup_main.cc.

void nGuiHoriSliderGroup::OnFrame (   )  [virtual]
 

called per frame when parent widget is visible

Reimplemented from nGuiWidget.

Definition at line 139 of file nguihorislidergroup_main.cc.

void nGuiHoriSliderGroup::OnEvent (  const nGuiEvent &  event  )  [virtual]
 

notify widget of an event

Reimplemented from nGuiWidget.

Definition at line 169 of file nguihorislidergroup_main.cc.

void nGuiHoriSliderGroup::SetLeftTextAlignment (  nGuiTextLabel::Alignment  a  )  [inline, virtual]
 

set alignment of text in left label

Definition at line 367 of file nguihorislidergroup.h.

void nGuiHoriSliderGroup::SetRightTextAlignment (  nGuiTextLabel::Alignment  a  )  [inline, virtual]
 

set alignment of text in right label

Definition at line 377 of file nguihorislidergroup.h.

nGuiSlider2 * nGuiHoriSliderGroup::GetSlider (   )  const [virtual]
 

set alignment of text in right label

Definition at line 187 of file nguihorislidergroup_main.cc.

Member Data Documentation

nString nGuiHoriSliderGroup::labelFont [protected]
 

Definition at line 97 of file nguihorislidergroup.h.

nString nGuiHoriSliderGroup::leftText [protected]
 

Definition at line 98 of file nguihorislidergroup.h.

nString nGuiHoriSliderGroup::rightText [protected]
 

Definition at line 99 of file nguihorislidergroup.h.

DisplayFormat nGuiHoriSliderGroup::displayFormat [protected]
 

Definition at line 100 of file nguihorislidergroup.h.

float nGuiHoriSliderGroup::leftWidth [protected]
 

Definition at line 101 of file nguihorislidergroup.h.

float nGuiHoriSliderGroup::rightWidth [protected]
 

Definition at line 102 of file nguihorislidergroup.h.

float nGuiHoriSliderGroup::minValue [protected]
 

Definition at line 103 of file nguihorislidergroup.h.

float nGuiHoriSliderGroup::maxValue [protected]
 

Definition at line 104 of file nguihorislidergroup.h.

float nGuiHoriSliderGroup::curValue [protected]
 

Definition at line 105 of file nguihorislidergroup.h.

float nGuiHoriSliderGroup::knobSize [protected]
 

Definition at line 106 of file nguihorislidergroup.h.

float nGuiHoriSliderGroup::increment [protected]
 

Definition at line 107 of file nguihorislidergroup.h.

bool nGuiHoriSliderGroup::snapToIncrement [protected]
 

Definition at line 108 of file nguihorislidergroup.h.

nGuiTextLabel::Alignment nGuiHoriSliderGroup::leftTextAlignment [protected]
 

Definition at line 109 of file nguihorislidergroup.h.

nGuiTextLabel::Alignment nGuiHoriSliderGroup::rightTextAlignment [protected]
 

Definition at line 110 of file nguihorislidergroup.h.

nRef<nGuiTextLabel> nGuiHoriSliderGroup::refLeftLabel [protected]
 

Definition at line 111 of file nguihorislidergroup.h.

nRef<nGuiTextLabel> nGuiHoriSliderGroup::refRightLabel [protected]
 

Definition at line 112 of file nguihorislidergroup.h.

nRef<nGuiSlider2> nGuiHoriSliderGroup::refSlider [protected]
 

Definition at line 113 of file nguihorislidergroup.h.

The documentation for this class was generated from the following files:
Nebula Device 2 documentation generated by doxygen at Sun Apr 8 20:05:53 2007

Copyright © 1999-2005 by the contributing authors. Ideas, requests, problems: Send feedback.