GLOW Reference

GLOW API version 1.0 reference

class GlowLabeledSliderWidget

General information

type: class
inherits: GlowSliderWidget
module: glowSliderWidget

GlowLabeledSliderWidget is a numeric slider widget that includes a label. It supports both vertical and horizontal sliders, either ascending or descending, with either linear or logarithmic scale. It also packs the label appropriately.

GLOW programs that make use of labeled slider widgets should use this class.

Constants

Positioning constants
These constants specify positioning of the main label.

enum GlowLabeledSliderWidget::LabelPosition defaultLabelPosition
enum GlowLabeledSliderWidget::LabelPosition leftLabelPosition
enum GlowLabeledSliderWidget::LabelPosition rightLabelPosition
enum GlowLabeledSliderWidget::LabelPosition topLabelPosition
enum GlowLabeledSliderWidget::LabelPosition bottomLabelPosition

Options
These constants are inherited from GlowSliderWidget.

enum GlowSliderWidget::Options defaultOptions
enum GlowSliderWidget::Options ticksOnBottom
enum GlowSliderWidget::Options ticksOnRight
enum GlowSliderWidget::Options ticksOnTop
enum GlowSliderWidget::Options ticksOnLeft
enum GlowSliderWidget::Options increasing
enum GlowSliderWidget::Options decreasing
enum GlowSliderWidget::Options linear
enum GlowSliderWidget::Options logarithmic

Packing constants
These constants are inherited from GlowWidget.

enum GlowWidget::AutoPackError noAutoPackError
enum GlowWidget::AutoPackError hAutoPackError
enum GlowWidget::AutoPackError vAutoPackError

enum GlowWidget::AutoPackOptions noReshape
enum GlowWidget::AutoPackOptions preferredSize
enum GlowWidget::AutoPackOptions expandPreferredSize
enum GlowWidget::AutoPackOptions forcedSize
enum GlowWidget::AutoPackOptions noMove
enum GlowWidget::AutoPackOptions leftPos
enum GlowWidget::AutoPackOptions rightPos
enum GlowWidget::AutoPackOptions topPos
enum GlowWidget::AutoPackOptions bottomPos
enum GlowWidget::AutoPackOptions centerPos

enum { unspecifiedSize }
enum { unspecifiedPos }

Methods

Constructors and destructor

GlowLabeledSliderWidget(GlowWidget* parent, const GlowLabeledSliderParams& params)

Creates a new GlowLabeledSliderWidget using the given params and adds it to parent's children.

GlowLabeledSliderWidget(GlowWidgetRoot* root, const GlowLabeledSliderParams& params)

Creates a new GlowLabeledSliderWidget using the given params and adds it to the top level under root.

GlowLabeledSliderWidget(void)

Creates a new GlowLabeledSliderWidget but does not initialize it. A slider created in this way may not be used until its Init() method is called.

void Init(GlowWidget* parent, const GlowLabeledSliderParams& params)

Initializes a new GlowLabeledSliderWidget using the given params and adds it to parent's children.

void Init(GlowWidgetRoot* root, const GlowLabeledSliderParams& params)

Initializes a new GlowLabeledSliderWidget using the given params and adds it to the top level under root.

virtual ~GlowLabeledSliderWidget(void)

Inherited methods
These methods are inherited from GlowWidgetLabelHelper.

int GetLabelSpacing(void) const

void SetLabelSpacing(int spacing)

int GetLabelPosition(void) const

void SetLabelPosition(int position)

int GetLabelWidth(void) const

void SetLabelWidth(int width)

int GetLabelHeight(void) const

void SetLabelHeight(int height)

const char* GetLabelText(void) const

void SetLabelText(const char* text)

GlowFont GetLabelFont(void) const

void SetLabelFont(GlowFont font)

GlowColor GetLabelTextColor(void) const

void SetLabelTextColor(GlowColor font)

GlowColor GetLabelDisableTextColor(void) const

void SetLabelDisableTextColor(GlowColor font)

Inherited methods
These methods are inherited from GlowSliderWidget.

double GetValue(void) const

double GetMinimum(void) const

double GetMaximum(void) const

void SetValue(double val)

void SetMinimum(double val)

void SetMaximum(double val)

int GetNumTickMarks(void) const

void SetNumTickMarks(int numTicks)

int GetOptions(void) const

void SetOptions(int options)

GlowColor GetStripColor(void) const

void SetStripColor(GlowColor c)

GlowColor GetIndicatorColor(void) const

void SetIndicatorColor(GlowColor c)

GlowColor GetTickMarkColor(void) const

void SetTickMarkColor(GlowColor c)

GlowColor GetHiliteIndicatorColor(void) const

void SetHiliteIndicatorColor(GlowColor c)

GlowColor GetDisableStripColor(void) const

void SetDisableStripColor(GlowColor c)

GlowColor GetDisableIndicatorColor(void) const

void SetDisableIndicatorColor(GlowColor c)

GlowColor GetDisableTickMarkColor(void) const

void SetDisableTickMarkColor(GlowColor c)

GlowColor GetDisableOutlineColor(void) const

void SetDisableOutlineColor(GlowColor c)

GlowColor GetLightBevelColor(void) const

void SetLightBevelColor(GlowColor c)

GlowColor GetDarkBevelColor(void) const

void SetDarkBevelColor(GlowColor c)

TSender<const GlowSliderMessage&>& Notifier(void)

Inherited methods
These methods are inherited from GlowWidget.

void Move(int x, int y)

int PositionX(void) const

int PositionY(void) const

int RootPositionX(void) const

int RootPositionY(void) const

int GlobalPositionX(void) const

int GlobalPositionY(void) const

void Reshape(int width, int height)

int Width(void) const

int Height(void) const

GlowWidget::AutoPackError AutoPack(int leftLimit, int rightLimit, int topLimit, int bottomLimit, GlowWidget::AutoPackOptions hOption, GlowWidget::AutoPackOptions vOption, int& leftMargin, int& rightMargin, int& topMargin, int& bottomMargin)
GlowWidget::AutoPackError AutoPack(int leftLimit, int rightLimit, int topLimit, int bottomLimit, GlowWidget::AutoPackOptions hOption, GlowWidget::AutoPackOptions vOption)

GlowWidget::AutoPackError AutoReshape(int& leftMargin, int& rightMargin, int& topMargin, int& bottomMargin)
GlowWidget::AutoPackError AutoReshape()

void Hide(void)

void Show(void)

bool IsVisible(void) const

bool IsInvisible(void) const

bool IsVisibleMasked(void) const

void Refresh(void)

void SetRefreshEnabled(bool enabled)

bool IsRefreshEnabled(void) const

void SetClipping(bool clip)

bool IsClipping(void)

void GrabKeyboardFocus(void)

Sliders should not attempt to grab the keyboard focus unless a subclass makes use of keyboard events.

void RelinquishKeyboardFocus(void)

bool HasKeyboardFocus(void)

GlowWidgetRoot* Root(void)

void SetRefCon(long refcon)

long GetRefCon(void)

Inherited methods
These methods are inherited from GlowComponent.

void Close(void)

GlowComponent* Parent(void) const

GlowSubwindow* WhichWindow(void)

GlowSubwindow* ParentWindow(void) const

GlowWindow* ToplevelWindow(void)

bool IsToplevel(void) const

GlowComponent* Next(void) const

GlowComponent* Prev(void) const

int NumChildren(void) const

GlowComponent* FirstChild(void) const

GlowComponent* LastChild(void) const

void ReorderChild(GlowComponent* child, GlowComponent* pos)

void KillChildren(void)

void Activate(void)

void Deactivate(void)

bool IsActive(void)

bool IsInactive(void)

bool IsActiveStandby(void)

void Paint(void)

Protected methods for subclasses

Initialization

void Init(GlowWidgetRoot* root, GlowWidget* parent, const GlowLabeledSliderParams& params)

Initializes a new GlowLabeledSliderWidget using the given params and adds it to root's hierarchy under parent. parent must be present in root's hierarchy.

Inherited methods
These methods are inherited from GlowWidget.

void NormalizeCoordinates(int x, int y, GLfloat& xn, GLfloat& yn) const

void RegisterMouseEvents(void)

void RegisterKeyboardEvents(void)

void UnegisterMouseEvents(void)

void UnregisterKeyboardEvents(void)

Overrideable methods

Inherited methods
These methods are inherited from GlowSliderWidget.

virtual void OnDragged(Glow::MouseButton mouseButton, Glow::Modifiers modifiers)

virtual void OnReleased(Glow::MouseButton mouseButton, Glow::Modifiers modifiers)

Inherited methods
These methods are inherited from GlowWidget.

virtual void OnWidgetPaint(void)

GlowSliderWidget overrides this method to draw the slider. You should not override it again unless a subclass needs to modify how sliders are drawn.

virtual void OnWidgetMouseDown(Glow::MouseButton mouseButton, int x, int y, Glow::Modifiers modifiers)

GlowSliderWidget overrides this method to handle mouse events. You should not override it again unless a subclass needs to modify how events are handled.

virtual void OnWidgetMouseUp(Glow::MouseButton mouseButton, int x, int y, Glow::Modifiers modifiers)

GlowSliderWidget overrides this method to handle mouse events. You should not override it again unless a subclass needs to modify how events are handled.

virtual void OnWidgetMouseDrag(int x, int y)

GlowSliderWidget overrides this method to handle mouse events. You should not override it again unless a subclass needs to modify how events are handled.

virtual void OnWidgetKeyboard(Glow::KeyCode key, int x, int y, Glow::Modifiers modifiers)

The standard GlowLabeledSliderWidget does not handle keyboard events. Override this method if a subclass needs to receive keyboard events.

virtual void OnWidgetMove(int x, int y)

virtual void OnWidgetReshape(int width, int height)

virtual void OnWidgetInvisible(void)

virtual void OnWidgetVisible(void)

virtual void OnWidgetDeactivate(void)

virtual void OnWidgetActivate(void)

virtual void OnGotKeyboardFocus(void)

virtual void OnLostKeyboardFocus(void)

virtual GlowWidget::AutoPackError OnAutoPack(int hSize, int vSize, GlowWidget::AutoPackOptions hOption, GlowWidget::AutoPackOptions vOption, int& leftMargin, int& rightMargin, int& topMargin, int& bottomMargin)

GlowLabeledSliderWidget implements this method to pack a labeled slider. Override it if a subclass requires different packing.

Inherited methods
These methods are inherited from GlowComponent, but are used by GlowWidget and should not be overridden again.

virtual void OnActivate(void)

virtual void OnDeactivate(void)

virtual void OnBeginPaint(void)

virtual void OnEndPaint(void)

Back to
Table of contents

The GLOW Toolkit