GLOW API version 1.0 reference

Back to Table of contents

class GlowRadioGroupWidget

General information

type: class
inherits: GlowPanelWidget
module: glowRadioButtonWidget

GlowRadioGroupWidget is a group of mutually exclusive radio buttons contained in a group box.

GLOW programs that make use of radio button widgets should use this class.

Constants

Inherited constants
These constants are inherited from GlowPanelWidget.

enum GlowPanelWidget::Style transparentStyle
enum GlowPanelWidget::Style plainStyle
enum GlowPanelWidget::Style etchedStyle
enum GlowPanelWidget::Style raisedStyle
enum GlowPanelWidget::Style loweredStyle

Inherited 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

GlowRadioGroupWidget(GlowWidget* parent, const GlowRadioGroupParams& params)

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

GlowRadioGroupWidget(GlowWidgetRoot* root, const GlowRadioGroupParams& params)

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

GlowRadioGroupWidget(void)

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

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

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

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

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

virtual ~GlowRadioGroupWidget(void)

Attributes

GlowRadioButtonWidget* GetState(void) const

Returns the current state of the radio group.

void SetState(GlowRadioButtonWidget* state)

Sets the current state of the radio group.

Other methods

TSender<const GlowRadioButtonMessage&>& Notifier(void)

Returns a reference to the sender used by the radio group to notify objects of changes to the state. Bind this sender to a GlowRadioButtonReceiver to cause that receiver to be notified when the user chooses a new radio button.

Inherited methods
These methods are inherited from GlowPanelWidget.

int GetStyle(void) const

void SetStyle(int style)

GlowColor GetBackColor(void) const

void SetBackColor(GlowColor c)

GlowColor GetLightBevelColor(void) const

void SetLightBevelColor(GlowColor c)

GlowColor GetDarkBevelColor(void) const

void SetDarkBevelColor(GlowColor c)

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)

Radio groups 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 GlowRadioGroupParams& params)

Initializes a new GlowRadioGroupWidget 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

Event handlers
These methods are called as soon as a widget-level event occurs. The default methods typically send the appropriate messages to the attached receivers.

virtual void OnHit(GlowRadioButtonWidget* buttonWidget, Glow::MouseButton mouseButton, Glow::Modifiers modifiers)

Called when a radio button has been selected. buttonWidget points to the new button widget, mouseButton is the mouse button pressed (see constants in Glow), and modifiers gives the keyboard modifiers that were down when the mouse button was pressed. The default method sets the state to the new button widget and sends messages to the attached GlowRadioButtonReceivers.

Inherited methods
These methods are inherited from GlowWidget.

virtual void OnWidgetPaint(void)

GlowRadioGroupWidget overrides this method to draw the group box for the radio group. You should not override it again unless a subclass needs to modify how radio group boxes are drawn.

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

GlowRadioGroupWidgets do not need to receive mouse events. Instead, the individual radio buttons will handle events. Override this method if your subclass needs to change this behavior.

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

GlowRadioGroupWidgets do not need to receive mouse events. Instead, the individual radio buttons will handle events. Override this method if your subclass needs to change this behavior.

virtual void OnWidgetMouseDrag(int x, int y)

GlowRadioGroupWidgets do not need to receive mouse events. Instead, the individual radio buttons will handle events. Override this method if your subclass needs to change this behavior.

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

The standard GlowRadioGroupWidget 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)

GlowRadioGroupWidget implements this method to pack a radio group. 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