GLOW API version 1.0 reference

Back to Table of contents

class GlowWidgetWindow

General information

type: class
inherits: GlowWindow, GlowWidgetRoot
module: glowWidget

GlowWidgetWindow is a toplevel window that contains and manages widgets.

GLOW programs that use widgets may place them in a toplevel window using a GlowWidgetWindow.

Methods

Constructors and destructor

GlowWidgetWindow(const GlowWidgetWindowParams& params)

Creates a new GlowWidgetWindow with options specified by the given params.

GlowWidgetWindow(const char* title, int x, int y, int width, int height, Glow::BufferType mode = GlowWidgetWindowParams::defaults.mode, Glow::EventMask eventMask = GlowWidgetWindowParams::defaults.eventMask, GlowColor backColor = GlowWidgetWindowParams::defaults.backColor)

Creates a new GlowWidgetWindow with options specified by the given params. x and y denote the pixel location of the top left corner of the window, in screen 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.

GlowWidgetWindow(void)

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

void Init(const GlowWidgetWindowParams& params)

Initializes the GlowWidgetWindow with options specified by the given params.

void Init(const char* title, int x, int y, int width, int height, Glow::BufferType mode = GlowWidgetWindowParams::defaults.mode, Glow::EventMask eventMask = GlowWidgetWindowParams::defaults.eventMask, GlowColor backColor = GlowWidgetWindowParams::defaults.backColor)

Initializes the GlowWidgetWindow with options specified by the given params. x and y denote the pixel location of the top left corner of the window, in screen 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 ~GlowWidgetWindow(void)

The destructor for GlowWidgetWindow removes the GLUT window 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 GlowWindow.

void Maximize(void)

void Iconify(void)

const char* GetTitle(void) const

void SetTitle(const char* title)

const char* GetIconTitle(void) const

void SetIconTitle(const char* title)

Inherited methods
These methods are inherited from GlowSubwindow.

int PositionX(void) const

Note: for a toplevel window, this returns the same value as GlobalPositionX.

int PositionY(void) const

Note: for a toplevel window, this returns the same value as GlobalPositionY.

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

Note: For a toplevel window, Parent() returns 0.

GlowSubwindow* WhichWindow(void)

Note: For a toplevel window, WhichWindow() returns this.

GlowSubwindow* ParentWindow(void) const

Note: For a toplevel window, ParentWindow() returns 0.

GlowWindow* ToplevelWindow(void)

Note: For a toplevel window, ToplevelWindow() returns this.

bool IsToplevel(void) const

Note: For a toplevel window, returns true.

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)

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

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

GlowWidgetWindow 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)

GlowWidgetWindow 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)

GlowWidgetWindow 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)

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

virtual void OnEndPaint(void)

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

virtual void OnActivate(void)

virtual void OnDeactivate(void)

Back to Table of contents