GLOW API version 1.0 reference

Back to Table of contents

class GlowQuickPaletteSubwindow

General information

type: class
inherits: GlowQuickPalette, GlowWidgetSubwindow
module: glowQuickPalette

GlowQuickPaletteSubwindow is a subwindow designed to contain a widget palette created using the QuickPalette interface.

GLOW programs that use the QuickPalette interface can use this class to create a widget palettes embedded in a subwindow.

Constants

Inherited constants
These constants are inherited from GlowQuickPalette.

enum { parentSetting }

enum GlowQuickPalette::Arrangement parentArrangement
enum GlowQuickPalette::Arrangement vertical
enum GlowQuickPalette::Arrangement horizontal

enum GlowQuickPalette::Alignment parentAlignment
enum GlowQuickPalette::Alignment alignTop
enum GlowQuickPalette::Alignment alignBottom
enum GlowQuickPalette::Alignment alignLeft
enum GlowQuickPalette::Alignment alignRight
enum GlowQuickPalette::Alignment alignCenter
enum GlowQuickPalette::Alignment alignExpand

Inherited constants
These constants are inherited from GlowSubwindow.

enum { parentWindowSize }

Methods

Constructors and destructor

GlowQuickPaletteSubwindow(GlowComponent* parent, int x = 0, int y = 0, int width = GlowSubwindow::parentWindowSize, int height = GlowSubwindow::parentWindowSize, GlowQuickPalette::Arrangement arrangement = GlowQuickPalette::vertical, GlowQuickPalette::Alignment alignment = GlowQuickPalette::alignLeft, int spacing = 8, int hmargin = 10, int vmargin = 10)

Creates a new GlowQuickPaletteSubwindow with options specified by the given params. parent gives the parent component for the subwindow. x and y denote the pixel location of the top left corner of the subwindow, in parent window pixel coordinates. width and height specify the size of the subwindow. arrangement specifies whether widgets in this palette should be arranged vertically in a column or horizontally in a row. alignment denotes the alignment of widgets. spacing denotes the spacing in pixels between widgets. hmargin and vmargin denote the spacing between the pixels and the subwindow border.

Packing methods
This method does final packing and displaying of widgets

void Pack(bool resizeOnPack = true)

Packs the subwindow according to the current parameters and arranges the contents. If resizeOnPack is set, resizes the subwindow to match the contained widgets. You should call this method after adding all your widgets to the subwindow.

Widget creation methods
These methods are inherited from GlowQuickPalette.

GlowQuickPanelWidget* AddPanel(GlowPanelWidget::Style style = GlowPanelWidget::plainStyle, const char* label = 0, GlowQuickPalette::Arrangement arrangement = GlowQuickPalette::parentArrangement, GlowQuickPalette::Alignment alignment = GlowQuickPalette::parentAlignment, int spacing = GlowQuickPalette::parentSetting, int hmargin = GlowQuickPalette::parentSetting, int vmargin = GlowQuickPalette::parentSetting)

GlowQuickPanelWidget* AddArrangingPanel(GlowQuickPalette::Arrangement arrangement = GlowQuickPalette::parentArrangement, GlowQuickPalette::Alignment alignment = GlowQuickPalette::parentAlignment, int spacing = GlowQuickPalette::parentSetting, int inset = 0)

GlowPanelWidget* AddFixedPanel(int width, int height, GlowPanelWidget::Style style = GlowPanelWidget::plainStyle)

GlowSeparatorWidget* AddSeparator(GlowSeparatorWidget::Style style = GlowSeparatorWidget::valleyStyle)

GlowPushButtonWidget* AddPushButton(const char* label, GlowPushButtonReceiver* receiver = 0)

GlowDismissPushButtonWidget* AddDismissPushButton(const char* label, GlowComponent* toDismiss, GlowPushButtonReceiver* receiver = 0)

GlowMenuButtonWidget* AddMenuButton(const char* label, GlowMenu* menu, GlowMenuButtonWidget::IconType icon = GlowMenuButtonWidget::menuIcon)

GlowLabeledPopupMenuWidget* AddPopupMenu(const char* label, GlowPopupMenuReceiver* receiver = 0)

GlowCheckBoxWidget* AddCheckBox(const char* label, GlowCheckBoxWidget::State initialValue = GlowCheckBoxWidget::off, GlowCheckBoxReceiver* receiver = 0)

GlowQuickRadioGroupWidget* AddRadioGroup(GlowQuickPalette::Arrangement arrangement = GlowQuickPalette::vertical, int spacing = 3, GlowRadioButtonReceiver* receiver = 0)

GlowLabeledSliderWidget* AddSlider(float min, float max, float initial, GlowSliderWidget::Options options = GlowSliderWidget::defaultOptions, int numTicks = 2, const char* valueLabel = 0, const char* label = 0, GlowSliderReceiver* receiver = 0)

GlowScrollBarWidget* AddScrollBar(long min, long max, long span, long initialTop, GlowScrollBarReceiver* receiver = 0)

GlowLabeledTextFieldWidget* AddTextField(int width, const char* text = "", const char* label = 0)

GlowLabeledHiddenTextFieldWidget* AddHiddenTextField(int width, const char* text = "", char hideCharacter = '#', const char* label = 0)

GlowLabelWidget* AddLabel(const char* text)

Packing and arrangement methods
These methods are inherited from GlowQuickPalette.

GlowQuickPalette::Arrangement GetArrangement(void) const

void SetArrangement(GlowQuickPalette::Arrangement value)

GlowQuickPalette::Alignment GetAlignment(void) const

void SetAlignment(GlowQuickPalette::Alignment value)

int GetSpacing(void) const

void SetSpacing(int value)

int GetHMargin(void) const

int GetVMargin(void) const

void SetHMargin(int value)

void SetVMargin(int value)

Information
These methods are inherited from GlowQuickPalette.

GlowQuickPanelWidget* QuickPaletteRoot(void) const

Inherited methods
These methods are inherited from GlowSubwindow.

int PositionX(void) const

int PositionY(void) const

int GlobalPositionX(void) const

int GlobalPositionY(void) const

int Width(void) const

int Height(void) const

void Move(int x, int y)

void Reshape(int width, int height)

void Raise(void)

void Lower(void)

void Hide(void)

void Show(void)

void Refresh(void)

void SetRefreshEnabled(bool enabled)

bool IsRefreshEnabled(void) const

void SetAutoSwapBuffersEnabled(bool enabled)

bool IsAutoSwapBuffersEnabled(void) const

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

Glow::BufferType GetBufferType(void) const

GlowMenu* GetMenu(Glow::MouseButton mouseButton) const

void SetMenu(Glow::MouseButton mouseButton, GlowMenu* menu = 0)

void UnsetMenu(Glow::MouseButton mouseButton)

int GetCursor(void) const

void SetCursor(int cursor)

Glow::EventMask GetEventMask(void) const

Glow::EventMask GetInactiveEventMask(void) const

void SetEventMask(Glow::EventMask mask)

void SetInactiveEventMask(Glow::EventMask mask)

int GlutWindowNum(void) const

void MakeCurGlutWindow(void)

int GlutInfo(int whichInfo) const

Inherited methods
These methods are inherited from GlowComponent.

GlowComponent* Parent(void) const

GlowSubwindow* WhichWindow(void)

Note: For a subwindow, WhichWindow() returns this.

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)

Overrideable methods

Inherited events
These methods are inherited from GlowSubwindow. Note that you normally should not override event methods in a GlowQuickPaletteSubwindow because the widget system will handle events for you.

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

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

virtual void OnMenuDown(int x, int y)

virtual void OnMenuUp()

virtual void OnMouseMotion(int x, int y)

virtual void OnMouseDrag(int x, int y)

virtual void OnMouseEnter(void)

virtual void OnMouseExit(void)

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

virtual void OnDirectMenuHit(const GlowMenuMessage& message)

virtual void OnReshape(int width, int height)

virtual void OnInvisible(void)

virtual void OnVisible(void)

Inherited methods
These overrideable methods are inherited from GlowComponent. Note that you normally should not override these methods in a GlowQuickPaletteSubwindow because the widget system will handle them for you.

virtual bool OnBeginPaint(void)

virtual void OnEndPaint(void)

virtual void OnActivate(void)

virtual void OnDeactivate(void)

Back to Table of contents