GLOW Reference

GLOW API version 1.0 reference

class GlowHiddenTextFieldWidget

General information

type: class
inherits: GlowTextFieldWidget
module: glowTextFieldWidget

GlowHiddenTextFieldWidget is an editable text field whose contents are hidden.

GLOW programs that require text fields with masked entry, such as password fields, should use this class.

Constants

Inherited constants
These constants are inherited from GlowTextFieldWidget.

enum GlowTextFieldWidget::Style plainStyle
enum GlowTextFieldWidget::Style etchedStyle
enum GlowTextFieldWidget::Style raisedStyle
enum GlowTextFieldWidget::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

GlowHiddenTextFieldWidget(GlowWidget* parent, const GlowTextFieldParams& params, char hideCharacter = '#')

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

GlowHiddenTextFieldWidget(GlowWidgetRoot* root, const GlowTextFieldParams& params, char hideCharacter = '#')

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

GlowHiddenTextFieldWidget(void)

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

void Init(GlowWidget* parent, const GlowTextFieldParams& params, char hideCharacter = '#')

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

void Init(GlowWidgetRoot* root, const GlowTextFieldParams& params, char hideCharacter = '#')

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

virtual ~GlowHiddenTextFieldWidget(void)

Hidden text field methods
These methods control aspects unique to a hidden text field.

const char* GetTextChars(void) const

Returns the real text in the field (not the mask characters). Note that this method replaces one of the same name in GlowTextFieldWidget.

const std::string& GetTextString(void) const

Returns the real text in the field (not the mask characters). Note that this method replaces one of the same name in GlowTextFieldWidget.

void SetText(const char* text)

Sets the real text in the field, and fills the field with mask characters as appropriate. Note that this method replaces one of the same name in GlowTextFieldWidget.

void SetText(const std::string& str)

Sets the real text in the field, and fills the field with mask characters as appropriate. Note that this method replaces one of the same name in GlowTextFieldWidget.

std::string GetSelectionString(void) const

Returns the real selected text in the field (not the mask characters). Note that this method replaces one of the same name in GlowTextFieldWidget.

char GetHideCharacter(void) const

Returns the current character used to hide the text.

void SetHideCharacter(char ch)

Sets the character used to hide the text.

Inherited methods
These methods are inherited from GlowTextFieldWidget.

int GetStyle(void) const

void SetStyle(int style)

GlowFont GetFont(void) const

void SetFont(GlowFont font)

int GetBlinkInterval(void) const

void SetBlinkInterval(int interval)

int GetAutoScrollInterval(void) const

void SetAutoScrollInterval(int interval)

int GetSelectionLength(void) const

int GetSelectionStart(void) const

int GetSelectionEnd(void) const

void SetSelection(int start, int end)

void SetSelection(int position)

void ReplaceSelectionWith(const char* text)

void ReplaceSelectionWith(const std::string& str)

GlowColor GetBackColor(void) const

void SetBackColor(GlowColor c)

GlowColor GetTextColor(void) const

void SetTextColor(GlowColor c)

GlowColor GetCaretColor(void) const

void SetCaretColor(GlowColor c)

GlowColor GetFocusBackColor(void) const

void SetFocusBackColor(GlowColor c)

GlowColor GetFocusTextColor(void) const

void SetFocusTextColor(GlowColor c)

GlowColor GetFocusCaretColor(void) const

void SetFocusCaretColor(GlowColor c)

GlowColor GetHiliteBackColor(void) const

void SetHiliteBackColor(GlowColor c)

GlowColor GetHiliteTextColor(void) const

void SetHiliteTextColor(GlowColor c)

GlowColor GetDisableBackColor(void) const

void SetDisableBackColor(GlowColor c)

GlowColor GetDisableTextColor(void) const

void SetDisableTextColor(GlowColor c)

GlowColor GetDisableCaretColor(void) const

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

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)

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 GlowTextFieldParams& params, char hideCharacter)

Initializes a new GlowHiddenTextFieldWidget 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 GlowWidget.

virtual void OnWidgetPaint(void)

GlowTextFieldWidget overrides this method to draw the text field. You should not override it again unless a subclass needs to modify how text fields are drawn.

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

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

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

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

GlowHiddenTextFieldWidget overrides this method to intercept keyboard events and mask characters. You should not override it again unless a subclass needs to modify how events are handled.

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)

GlowTextFieldWidget implements this method to pack a text field. 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