GLOW API version 1.0 reference

Back to Table of contents

class GlowWidgetSubwindow

General information

type: class
inherits: GlowSubwindow, GlowWidgetRoot
module: glowWidget

GlowWidgetSubwindow is a subwindow that contains and manages widgets.

GLOW programs that use widgets may place them in a subwindow using a GlowWidgetSubwindow.

Methods

Constructors and destructor

GlowWidgetSubwindow(GlowComponent* parent, const GlowWidgetSubwindowParams& params)

Creates a new GlowWidgetSubwindow with options specified by the given params. The subwindow is inserted as a child under parent.

GlowWidgetSubwindow(GlowComponent* parent, int x, int y, int width, int height, Glow::BufferType mode = GlowWidgetSubwindowParams::defaults.mode, Glow::EventMask eventMask = GlowWidgetSubwindowParams::defaults.eventMask, GlowColor backColor = GlowWidgetSubwindowParams::defaults.backColor)

Creates a new GlowWidgetSubwindow with options specified by the given params. The subwindow is inserted as a child under parent. x and y denote the pixel location of the top left corner of the subwindow, in parent window coordinates. width and height specify the width and height in pixels. mode gives the type of frame buffer to use, and eventMask specifies the types of events that are to be received. Normally, these two parameters should not be modified from the default. backColor gives the color of the background for the widgets.

GlowWidgetSubwindow(void)

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

void Init(GlowComponent* parent, const GlowWidgetSubwindowParams& params)

Initializes the GlowWidgetSubwindow with options specified by the given params. The subwindow is inserted as a child under parent.

void Init(GlowComponent* parent, int x, int y, int width, int height, Glow::BufferType mode = GlowWidgetSubwindowParams::defaults.mode, Glow::EventMask eventMask = GlowWidgetSubwindowParams::defaults.eventMask, GlowColor backColor = GlowWidgetSubwindowParams::defaults.backColor)

Initializes the GlowWidgetSubwindow with options specified by the given params. The subwindow is inserted as a child under parent. x and y denote the pixel location of the top left corner of the subwindow, in parent window coordinates. width and height specify the width and height in pixels. mode gives the type of frame buffer to use, and eventMask specifies the types of events that are to be received. Normally, these two parameters should not be modified from the default. backColor gives the color of the background for the widgets.

virtual ~GlowWidgetSubwindow(void)

The destructor for GlowWidgetSubwindow removes the GLUT subwindow and recursively deletes all widgets under it.

Inherited methods
These methods are inherited from GlowWidgetRoot.

GlowSubwindow* Subwindow(void) const

GlowColor GetBackColor(void) const

void SetBackColor(GlowColor c)

void SetKeyboardFocus(GlowWidget* widget)

GlowWidget* GetKeyboardFocus(void)

void AdvanceKeyboardFocus(void)

GlowWidget* FindWidget(int& x, int& y)

static void RegisterFilter(GlowWidgetKeyboardFilter* filter)

static void UnregisterFilter(GlowWidgetKeyboardFilter* filter)

static void UnregisterAllFilters(void)

static unsigned int NumRegisteredFilters(void)

static bool IsFilterRegistered(GlowWidgetKeyboardFilter* filter)

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 Show(void)

void Hide(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.

void Close(void)

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 methods
These overrideable methods are inherited from GlowSubwindow.

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

GlowWidgetSubwindow overrides this method to call GlowWidgetRoot::WRMouseDown().

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

GlowWidgetSubwindow overrides this method to call GlowWidgetRoot::WRMouseUp().

virtual void OnMenuDown(int x, int y)

virtual void OnMenuUp()

virtual void OnMouseMotion(int x, int y)

virtual void OnMouseDrag(int x, int y)

GlowWidgetSubwindow overrides this method to call GlowWidgetRoot::WRMouseDrag().

virtual void OnMouseEnter(void)

virtual void OnMouseExit(void)

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

GlowWidgetSubwindow overrides this method to call GlowWidgetRoot::WRKeyboard().

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.

virtual bool OnBeginPaint(void)

GlowWidgetSubwindow overrides this method to call GlowWidgetRoot::WRBeginPaint().

virtual void OnEndPaint(void)

GlowWidgetSubwindow overrides this method to call GlowWidgetRoot::WREndPaint().

virtual void OnActivate(void)

virtual void OnDeactivate(void)

Back to Table of contents