omgui::SecureEntryBox Class Reference

#include <omgui/secureentrybox.h>

Inherits omgui::TextWidget.

List of all members.


Detailed Description

A SecureEntryBox represents a simple, single lined TextWidget. Unlike an EntryBox, a SecureEntryBox is used to query sensitive information from the user, such as a password.

Public Types

typedef omgui::api::SecureEntryBox api_type
typedef omgui::event_traits
< TextWidget
event_traits
typedef SecureEntryBoxInitializer Initializer

Public Member Functions

void add_ref ()
 Increments the reference count for this Widget.
omgui::Connection connect (event_id event, SlotBase *slot, int priority=SIGNAL_PRIORITY_NORMAL)
 Connects an event using this Widget's object_id. Calls omgui::Manager::connect with supplied arguments.
void delete_range (const TextRange &range)
 Deletes a range of text from the widget.
void destroy ()
 Destroys this widget freeing all resources.
void disable ()
void enable (bool e)
 Enables or disables the widget. Disabled widgets cannot recieve user input.
void * get_handle () const
object_id get_id () const
api_typeget_impl () const
text_range_t get_insertion_point () const
text_range_t get_length () const
 Returns the number of characters in the widget.
omgui::Size get_max_size () const
 Returns the maximum size of the Widget. A value of 0 for width or height indicates that there is no maximum size in that direction.
omgui::Size get_min_size () const
 Returns the minimum size of the Widget. A value of 0 for width or height indicates that there is no minimum size in that direction.
omgui::Size get_natural_size () const
Pointer< Panelget_parent () const
Pointer< Windowget_parent_window () const
omgui::Point get_position () const
omgui::Rect get_rect () const
bool get_selection_bounds (TextRange &range) const
 Returns the selected range of text and whether or not there was a selection.
TextRange get_selection_range () const
omgui::Size get_size () const
string get_text (const TextRange &range) const
string get_text () const
void hide ()
text_range_t insert_text (const string &str)
 Inserts text at the insertion point.
text_range_t insert_text (const string &str, text_range_t pos)
 Inserts text at the specified position.
bool is_enabled () const
 Determines whether or not the widget is enabled. If any of a widget's parents are disabled, the widget is considered disabled.
bool is_hidden () const
 Returns whether or not this Widget has been hidden.
bool is_read_only () const
bool is_shown () const
 Returns whether or not the Widget is visible on the screen. If the Widget and all of its parent Widgets are not hidden then the Widget is shown.
void release ()
 Decrements the reference count for this Widget. Once the count reaches 0 the Widget will be deleted.
void set_insertion_point (text_range_t pos)
 Sets the insertion point (Cursor position). A negative value is allowed here and will set the insertion point relative to the end of the text, as described in TextRange.
void set_max_length (text_range_t len)
 Sets the maximum text length. Specify a value of -1 to indicate that there is no maximum text length.
void set_max_size (const omgui::Size &s)
 Sets the maximum size of the widget. A value of 0 for width or height indicates that there is no maximum size in that direction.
void set_min_size (const omgui::Size &s)
 Sets the minimum size of the Widget. A value of 0 for width or height indicates that there is no minimum size in that direction. If the Widget's current size is less than the newly specified minimum size, the object will be resized so that its size is equal to the newly specified minimum size.
void set_natural_size (const omgui::Size &s)
void set_position (const omgui::Point &p)
 Sets the position of a widget. If the widget is a TopLevel widget, the position value is in screen coordinates, otherwise it is client coordinates.
void set_read_only (bool b)
 Specifies whether or not this TextWidget is read only. Users cannot modify the contents of read only TextWidgets.
void set_rect (const omgui::Rect &r)
 Sets both the position and the size of the widget. If the widget is a TopLevel widget, the value is in screen coordinates, otherwise it is client coordinates.
void set_selection_bounds (const TextRange &range)
 Selects a range of text within the widget. The insertion point will be range.second.
void set_selection_range (const TextRange &range)
 Selects a range of text within the widget.
void set_size (const omgui::Size &s)
 Sets the absolute size of this widget. If the widget is a TopLevel widget, the value is in screen coordinates, otherwise it is client coordinates.
void set_text (const string &s)
void show (bool show=true, bool focus=false)
 Shows or hides a widget.

Static Public Member Functions

static Pointer< SecureEntryBoxcreate (const Initializer &initializer, object_id id=OBJECT_ID_ANY)

Protected Member Functions

void initialize (const Initializer &initializer)
 Constructs the native widget using the given initializer.
 SecureEntryBox (object_id id, api_type *impl)
 SecureEntryBox (object_id id)

Private Attributes

api_typem_impl

Member Typedef Documentation

Reimplemented from omgui::TextWidget.

typedef omgui::event_traits<TextWidget> omgui::TextWidget::event_traits [inherited]

Reimplemented from omgui::Widget.


Constructor & Destructor Documentation

omgui::SecureEntryBox::SecureEntryBox ( object_id  id  )  [protected]

omgui::SecureEntryBox::SecureEntryBox ( object_id  id,
api_type impl 
) [protected]


Member Function Documentation

void Widget::add_ref (  )  [virtual, inherited]

Increments the reference count for this Widget.

Implements omgui::RefCountable.

omgui::Connection Widget::connect ( event_id  event,
SlotBase slot,
int  priority = SIGNAL_PRIORITY_NORMAL 
) [inherited]

Connects an event using this Widget's object_id. Calls omgui::Manager::connect with supplied arguments.

Pointer< SecureEntryBox > omgui::SecureEntryBox::create ( const Initializer initializer,
object_id  id = OBJECT_ID_ANY 
) [static]

Creates a SecureEntryBox

void omgui::TextWidget::delete_range ( const TextRange range  )  [inherited]

Deletes a range of text from the widget.

void Widget::destroy (  )  [inherited]

Destroys this widget freeing all resources.

void Widget::disable (  )  [inherited]

void Widget::enable ( bool  e  )  [inherited]

Enables or disables the widget. Disabled widgets cannot recieve user input.

void * Widget::get_handle (  )  const [inherited]

Returns:
A native handle for the widget. This value is returned as a void*, and how you use this value is dependant on the port you are working with. For win32, simply casting the return value to a HWND is sufficient.
Todo:
Casting a pointer type to a type that isn't a pointer may not work under all circumstances

object_id omgui::Object::get_id (  )  const [inherited]

Returns:
This object's unique identifier

Reimplemented in omgui::MenuItem.

SecureEntryBox::api_type * omgui::SecureEntryBox::get_impl (  )  const

Reimplemented from omgui::TextWidget.

text_range_t omgui::TextWidget::get_insertion_point (  )  const [inherited]

Returns:
The insertion point (Cursor position).

text_range_t omgui::TextWidget::get_length (  )  const [inherited]

Returns the number of characters in the widget.

omgui::Size Widget::get_max_size (  )  const [inherited]

Returns the maximum size of the Widget. A value of 0 for width or height indicates that there is no maximum size in that direction.

Returns:
Maximum size of the widget.

omgui::Size Widget::get_min_size (  )  const [inherited]

Returns the minimum size of the Widget. A value of 0 for width or height indicates that there is no minimum size in that direction.

Returns:
Minimum size of the widget.

omgui::Size Widget::get_natural_size (  )  const [inherited]

Returns:
Natural size of the widget. The natural size is used by layout managers to determine how large to make widgets which are not expanded. Unless a natural size is explicitly specified by a call to set_natural_size or through an inintializer, this value is a calculated value and can vary from widget to widget and from port to port.

Pointer< Panel > Widget::get_parent (  )  const [inherited]

This function returns the parent Panel of this Widget. In the case where this Widget is the Content Panel of a Window, this function will return an empty pointer.

Returns:
The parent of this widget

Pointer< Window > Widget::get_parent_window (  )  const [inherited]

This function returns the Window which this Widget is either directly or indirectly a child of. In the case where this Widget is a Window, this function returns the owner Window, or an empty pointer if the Window is unowned.

Returns:
The Window which contains this widget.

omgui::Point Widget::get_position (  )  const [inherited]

Returns:
Position of the widget. If the widget is a TLW TLW, the position is in screen coordinates. Otherwise, the position is in client coordinates.

omgui::Rect Widget::get_rect (  )  const [inherited]

Returns:
Position and Size of this widget as a rectangle.

bool omgui::TextWidget::get_selection_bounds ( TextRange range  )  const [inherited]

Returns the selected range of text and whether or not there was a selection.

Parameters:
range [out] The selected range of text is returned through this parameter.
Remarks:
If the end of the text is selected, the value of length will be returned, not TextRange::END. If you had selected a range of text using negative ranges, their positive equivilants will be returned by this function.
Note:
If you need to know where the insertion point is relative to the selection position, use get_selection_range() instead.
Returns:
True if there was a selection, false if not.

TextRange omgui::TextWidget::get_selection_range (  )  const [inherited]

Returns:
The range of text that is currently selected.
This function returns a specially formatted TextRange struct. TextRange::first is the selection position, and TextRange::second is the insertion point. This function does not gaurantee to return a normalized TextRange, meaning that first may be greater than second. In that case, it means that the insertion point is closer to the beginning of the text than the selection position.

Note:
This function only performs as described on platforms that support this behavior. On platforms that don't support this behavior, this function is identicle to get_selection_bounds().
Remarks:
If the end of the text is selected, the value of length will be returned, not TextRange::END. If you had selected a range of text using negative ranges, their positive equivilants will be returned by this function.

omgui::Size Widget::get_size (  )  const [inherited]

Returns:
Absolute size of the widget

string omgui::TextWidget::get_text ( const TextRange range  )  const [inherited]

Returns:
The text in the requested range.

string omgui::TextWidget::get_text (  )  const [inherited]

Returns:
The text contained in the TextWidget.

void Widget::hide (  )  [inherited]

void omgui::SecureEntryBox::initialize ( const Initializer initializer  )  [protected]

Constructs the native widget using the given initializer.

text_range_t omgui::TextWidget::insert_text ( const string str  )  [inherited]

Inserts text at the insertion point.

Returns:
The new location of the insertion point.

text_range_t omgui::TextWidget::insert_text ( const string str,
text_range_t  pos 
) [inherited]

Inserts text at the specified position.

Returns:
The end point of the insertion, allowing for insert chaining.

bool Widget::is_enabled (  )  const [inherited]

Determines whether or not the widget is enabled. If any of a widget's parents are disabled, the widget is considered disabled.

Returns:
Whether or not the widget is enabled

bool Widget::is_hidden (  )  const [inherited]

Returns whether or not this Widget has been hidden.

If show(true) has been called the Widget is considered not to be hidden. If show(false) or hide() have been called the Widget is considered hidden. A Widget is also considered hidden if it was created without specifying show in its initializer. The hidden state of the parent Widget has no effect on the hidden state of this Widget.

Note:
The return value is not equivilant to !is_shown().
Todo:
Implement for gtk2 and cocoa

bool omgui::TextWidget::is_read_only (  )  const [inherited]

Returns:
Whether this TextWidget is in read only mode

bool Widget::is_shown (  )  const [inherited]

Returns whether or not the Widget is visible on the screen. If the Widget and all of its parent Widgets are not hidden then the Widget is shown.

Note:
The return value is not equivilant to !is_hidden().
Todo:
Verify the newly documented behavior for this function on gtk2 and cocoa ports

void Widget::release (  )  [virtual, inherited]

Decrements the reference count for this Widget. Once the count reaches 0 the Widget will be deleted.

Implements omgui::RefCountable.

void omgui::TextWidget::set_insertion_point ( text_range_t  pos  )  [inherited]

Sets the insertion point (Cursor position). A negative value is allowed here and will set the insertion point relative to the end of the text, as described in TextRange.

Postcondition:
The TextWidget is now focused
Todo:
MR: I'm not so sure about the focus postconditions reasonability

void omgui::TextWidget::set_max_length ( text_range_t  len  )  [inherited]

Sets the maximum text length. Specify a value of -1 to indicate that there is no maximum text length.

void Widget::set_max_size ( const omgui::Size s  )  [inherited]

Sets the maximum size of the widget. A value of 0 for width or height indicates that there is no maximum size in that direction.

If the Widget's current size is greater than the newly specified maximum size, the object will be resized so that its size is equal to the newly specified maximum size.

void Widget::set_min_size ( const omgui::Size s  )  [inherited]

Sets the minimum size of the Widget. A value of 0 for width or height indicates that there is no minimum size in that direction. If the Widget's current size is less than the newly specified minimum size, the object will be resized so that its size is equal to the newly specified minimum size.

If a child of this Widget has a minimum size larger than the minimum size of this Widget, the minimum size of this Widget will be effectively equal to the minimum size of that child Widget. This has an important implication for Windows and their content panels. If a Window has a minimum size of X, and a Panel A with minimum size Y > X is specified as the Window's content panel, the minimum content size of the Window is effectively Y. If a new Panel B with minimum size Z < Y is specified as the Window's content panel, the effective minimum content size for the window will be Y.

If an Widget is specified with a minimum size that is larger than the Widgets maximum size, or if a maximum size is later specified which is smaller than an existing minimum size, the minimum size will always take precedence over the maximal size. A minimum size of (100,100) and a maximal size of (50,50) results in a minimum size of (100,100) and a maximum size of (100,100). If the minimum size is later changed to (25,25), the maximum size is again (50,50) and the minimum size is (25,25). This case also applies to Window's and their content panels. A content panel's minimum size always takes precedence over a Window's maximum content size.

void Widget::set_natural_size ( const omgui::Size s  )  [inherited]

Sets the natural size for this widget. The natural size is used by layout managers to determine how large to make widgets which are not expanded. The default natural size has a width and height of 0, which means that an acceptible natural size will be calculated for the width and height. You can override the calculated value by specifying your own value for the width and or height.

void Widget::set_position ( const omgui::Point p  )  [inherited]

Sets the position of a widget. If the widget is a TopLevel widget, the position value is in screen coordinates, otherwise it is client coordinates.

void omgui::TextWidget::set_read_only ( bool  b  )  [inherited]

Specifies whether or not this TextWidget is read only. Users cannot modify the contents of read only TextWidgets.

void Widget::set_rect ( const omgui::Rect r  )  [inherited]

Sets both the position and the size of the widget. If the widget is a TopLevel widget, the value is in screen coordinates, otherwise it is client coordinates.

void omgui::TextWidget::set_selection_bounds ( const TextRange range  )  [inherited]

Selects a range of text within the widget. The insertion point will be range.second.

Remarks:
Use the value (0, TextRange::END) to select all of the text. A value of (N, TextRange::END) will select all of the text excluding the range [0, N).
Postcondition:
The TextWidget is now focused

void omgui::TextWidget::set_selection_range ( const TextRange range  )  [inherited]

Selects a range of text within the widget.

This function interprets the meaning of TextRange::first and TextRange::second differently than other functions. TextRange::first is the "selection position" and TextRange::second is the "insertion point". Unlike set_selection_bounds(), this function lets you determine where to place the insertion point in relation to the selection position. This function does not normalize range because that would destroy any insertion point information relative to the selection point.

Postcondition:
The TextWidget is now focused

void Widget::set_size ( const omgui::Size s  )  [inherited]

Sets the absolute size of this widget. If the widget is a TopLevel widget, the value is in screen coordinates, otherwise it is client coordinates.

If the size value specified is smaller than the minimum size or larger than the maximum size, the size value actually set will be equal to the minimum size or maximum size respectively.

void omgui::TextWidget::set_text ( const string s  )  [inherited]

Sets the text of the TextWidget.

void Widget::show ( bool  show = true,
bool  focus = false 
) [inherited]

Shows or hides a widget.

Note:
If this widget is a Panel which is currently functioning as a NotebookPage, this function will have no effect. Panel's which are NotebookPages are shown and hidden by the Notebook itself.

Reimplemented in omgui::TopLevel.


Member Data Documentation

Reimplemented from omgui::TextWidget.


doxygen SourceForge.net Logo