|
| ||||||||||||||||
A window is the basic user interface element. Everything inside is implementation specific functionality.
| Window (const char* id = 0)
| Window |
Constructor, creates a new windows with an ID
Parameters:
| id | String identifier of the new window |
| ~Window ()
| ~Window |
[virtual]
Destructor
| const String& toString ()
| toString |
[const virtual]
Retrive the standard name of this Window, used to search in lists
Returns: Identifier of this window
Reimplemented from GenObject.
| void title (const String& text)
| title |
[virtual]
| void context (const String& text)
| context |
[virtual]
Set the contextual information previously associated with this window
Parameters:
| text | New contextual information |
| bool setParams (const NamedList& params)
| setParams |
[virtual]
Set window parameters or widget contents
Parameters:
| params | List of parameters to set in the window and its widgets |
Returns: True if all parameters could be set
| void setOver (const Window* parent)
| setOver |
[pure virtual]
Force this window on top of another one which becomes its parent
Parameters:
| parent | Window to force as parent of this one |
| bool hasElement (const String& name)
| hasElement |
[pure virtual]
Check if this window has an element by name
Parameters:
| name | Name of the element to search for |
Returns: True if one element with the given name exists
| bool setActive (const String& name, bool active)
| setActive |
[pure virtual]
Set an element as interactive in the window
Parameters:
| name | Name of the element |
| active | True to make interactive, false to disallow interaction |
Returns: True if the operation was successfull
| bool setFocus (const String& name, bool select = false)
| setFocus |
[pure virtual]
Set an element as receiving input in the window
Parameters:
| name | Name of the element |
| select | Also select the content of the focused element |
Returns: True if the operation was successfull
| bool setShow (const String& name, bool visible)
| setShow |
[pure virtual]
Set the visibility of an element in the window
Parameters:
| name | Name of the element |
| visible | True to make element visible, false to hide it |
Returns: True if the operation was successfull
| bool setText (const String& name, const String& text)
| setText |
[pure virtual]
Set the displayed text of an element in the window
Parameters:
| name | Name of the element |
| text | Text value to set in the element |
Returns: True if the operation was successfull
| bool setCheck (const String& name, bool checked)
| setCheck |
[pure virtual]
Set the checked or toggled status of an element in the window
Parameters:
| name | Name of the element |
| checked | True to make element checked or toggled |
Returns: True if the operation was successfull
| bool setSelect (const String& name, const String& item)
| setSelect |
[pure virtual]
Set the selection of an item in an element in the window
Parameters:
| name | Name of the element |
| item | Name of the item that should be selected |
Returns: True if the operation was successfull
| bool setUrgent (const String& name, bool urgent)
| setUrgent |
[pure virtual]
Flag an element as requiring immediate attention
Parameters:
| name | Name of the element |
| urgent | True if the element requires immediate attention |
Returns: True if the operation was successfull
| bool hasOption (const String& name, const String& item)
| hasOption |
[pure virtual]
Check if an element has an item by its name
Parameters:
| name | Name of the element to search for |
| item | Name of the item that should be searched |
Returns: True if one item with the given name exists in the element
| bool addOption (const String& name, const String& item, bool atStart = false, const String& text = String::empty())
| addOption |
[pure virtual]
Add an item to an element that supports such an operation (list)
Parameters:
| name | Name of the element |
| item | Name of the item to add |
| atStart | True to insert item on the first position, false to append |
| text | Displayed text to associate with the item (not all lists support it) |
Returns: True if the operation was successfull
| bool delOption (const String& name, const String& item)
| delOption |
[pure virtual]
Remove an item from an element (list)
Parameters:
| name | Name of the element |
| item | Name of the item to remove |
Returns: True if the operation was successfull
| bool addTableRow (const String& name, const String& item, const NamedList* data = 0, bool atStart = false)
| addTableRow |
[virtual]
| bool delTableRow (const String& name, const String& item)
| delTableRow |
[virtual]
| bool setTableRow (const String& name, const String& item, const NamedList* data)
| setTableRow |
[virtual]
| bool getTableRow (const String& name, const String& item, NamedList* data = 0)
| getTableRow |
[virtual]
| bool clearTable (const String& name)
| clearTable |
[virtual]
| bool getText (const String& name, String& text)
| getText |
[pure virtual]
| bool getCheck (const String& name, bool& checked)
| getCheck |
[pure virtual]
| bool getSelect (const String& name, String& item)
| getSelect |
[pure virtual]
| void populate ()
| populate |
[pure virtual]
| void init ()
| init |
[pure virtual]
| void show ()
| show |
[pure virtual]
| void hide ()
| hide |
[pure virtual]
| void size (int width, int height)
| size |
[pure virtual]
| void move (int x, int y)
| move |
[pure virtual]
| void moveRel (int dx, int dy)
| moveRel |
[pure virtual]
| bool related (const Window* wnd)
| related |
[const virtual]
| void menu (int x, int y)
| menu |
[pure virtual]
| inline const String& id ()
| id |
[const]
Retrive the standard name of this Window
Returns: Identifier of this window
| inline const String& title ()
| title |
[const]
| inline const String& context ()
| context |
[const]
Get the contextual information previously associated with this window
Returns: String contextual information
| inline bool visible ()
| visible |
[const]
Get the visibility status of this window
Returns: True if window is visible, false if it's hidden
| inline void visible (bool yes)
| visible |
Set the visibility status of this window
Parameters:
| yes | True if window should be visible |
| inline bool master ()
| master |
[const]
Check if this window is a master (topmost) window
Returns: True if this window is topmost
| inline bool popup ()
| popup |
[const]
Check if this window is a popup window
Returns: True if this window is initially hidden
| String m_id | m_id |
[protected]
| String m_title | m_title |
[protected]
| String m_context | m_context |
[protected]
| bool m_visible | m_visible |
[protected]
| bool m_master | m_master |
[protected]
| bool m_popup | m_popup |
[protected]
| Generated by: root on dragoshel on Fri Aug 24 11:49:48 2007, using kdoc 2.0a54. |