Yate
|
An abstract user interface window. More...
#include <yatecbase.h>
Public Member Functions | |
Window (const char *id=0) | |
virtual | ~Window () |
virtual const String & | toString () const |
virtual void | title (const String &text) |
virtual void | context (const String &text) |
virtual bool | setParams (const NamedList ¶ms) |
virtual void | setOver (const Window *parent)=0 |
virtual bool | hasElement (const String &name)=0 |
virtual bool | setActive (const String &name, bool active)=0 |
virtual bool | setFocus (const String &name, bool select=false)=0 |
virtual bool | setShow (const String &name, bool visible)=0 |
virtual bool | setText (const String &name, const String &text, bool richText=false)=0 |
virtual bool | setCheck (const String &name, bool checked)=0 |
virtual bool | setSelect (const String &name, const String &item)=0 |
virtual bool | setUrgent (const String &name, bool urgent)=0 |
virtual bool | hasOption (const String &name, const String &item)=0 |
virtual bool | addOption (const String &name, const String &item, bool atStart=false, const String &text=String::empty())=0 |
virtual bool | getOptions (const String &name, NamedList *items)=0 |
virtual bool | delOption (const String &name, const String &item)=0 |
virtual bool | addLines (const String &name, const NamedList *lines, unsigned int max, bool atStart=false) |
virtual bool | addTableRow (const String &name, const String &item, const NamedList *data=0, bool atStart=false) |
virtual bool | setMultipleRows (const String &name, const NamedList &data, const String &prefix=String::empty()) |
virtual bool | insertTableRow (const String &name, const String &item, const String &before, const NamedList *data=0) |
virtual bool | delTableRow (const String &name, const String &item) |
virtual bool | setTableRow (const String &name, const String &item, const NamedList *data) |
virtual bool | updateTableRow (const String &name, const String &item, const NamedList *data=0, bool atStart=false) |
virtual bool | updateTableRows (const String &name, const NamedList *data, bool atStart=false) |
virtual bool | getTableRow (const String &name, const String &item, NamedList *data=0) |
virtual bool | clearTable (const String &name) |
virtual bool | getText (const String &name, String &text, bool richText=false)=0 |
virtual bool | getCheck (const String &name, bool &checked)=0 |
virtual bool | getSelect (const String &name, String &item)=0 |
virtual bool | setProperty (const String &name, const String &item, const String &value) |
virtual bool | getProperty (const String &name, const String &item, String &value) |
void | populate () |
void | init () |
virtual void | show ()=0 |
virtual void | hide ()=0 |
virtual void | size (int width, int height)=0 |
virtual void | move (int x, int y)=0 |
virtual void | moveRel (int dx, int dy)=0 |
virtual bool | related (const Window *wnd) const |
virtual void | menu (int x, int y)=0 |
virtual bool | canClose () |
const String & | id () const |
const String & | title () const |
const String & | context () const |
bool | visible () const |
void | visible (bool yes) |
bool | master () const |
bool | popup () const |
Static Public Member Functions | |
static bool | isValidParamPrefix (const String &prefix) |
Protected Member Functions | |
virtual void | doPopulate ()=0 |
virtual void | doInit ()=0 |
Protected Attributes | |
String | m_id |
String | m_title |
String | m_context |
bool | m_visible |
bool | m_master |
bool | m_popup |
bool | m_saveOnClose |
Friends | |
class | Client |
An abstract user interface window.
A window is the basic user interface element. Everything inside is implementation specific functionality.
Window | ( | const char * | id = 0 | ) |
Constructor, creates a new windows with an ID
id | String identifier of the new window |
virtual ~Window | ( | ) | [virtual] |
Destructor
virtual bool addLines | ( | const String & | name, |
const NamedList * | lines, | ||
unsigned int | max, | ||
bool | atStart = false |
||
) | [virtual] |
Append or insert text lines to a widget
name | The name of the widget |
lines | List containing the lines |
max | The maximum number of lines allowed to be displayed. Set to 0 to ignore |
atStart | True to insert, false to append |
virtual bool addOption | ( | const String & | name, |
const String & | item, | ||
bool | atStart = false , |
||
const String & | text = String::empty() |
||
) | [pure virtual] |
Add an item to an element that supports such an operation (list)
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) |
virtual bool addTableRow | ( | const String & | name, |
const String & | item, | ||
const NamedList * | data = 0 , |
||
bool | atStart = false |
||
) | [virtual] |
Add a row to a table owned by this window
name | Name of the element |
item | Name of the item to add |
data | Table's columns to set |
atStart | True to insert, false to append |
virtual bool canClose | ( | ) | [inline, virtual] |
Check if this window can be closed
virtual bool clearTable | ( | const String & | name | ) | [virtual] |
Clear (delete all rows) a table owned by this window
name | Name of the element |
const String& context | ( | ) | const [inline] |
Get the contextual information previously associated with this window
virtual void context | ( | const String & | text | ) | [virtual] |
Set the contextual information previously associated with this window
text | New contextual information |
Remove an item from an element (list)
name | Name of the element |
item | Name of the item to remove |
Delete a row from a table owned by this window
name | Name of the element |
item | Name of the item to remove |
virtual bool getCheck | ( | const String & | name, |
bool & | checked | ||
) | [pure virtual] |
Get the checked state of a checkable control
name | Name of the element |
checked | The checked state of the control |
Get an element's items
name | Name of the element to search for |
items | List to fill with element's items |
virtual bool getProperty | ( | const String & | name, |
const String & | item, | ||
String & | value | ||
) | [inline, virtual] |
Get a property from this window or from a widget owned by it
name | Name of the element |
item | Property's name |
value | Property's value |
Retrieve an element's selection
name | Name of the element |
item | String to fill with selection's contents |
virtual bool getTableRow | ( | const String & | name, |
const String & | item, | ||
NamedList * | data = 0 |
||
) | [virtual] |
Retrieve a row from a table owned by this window
name | Name of the element |
item | Name of the item to retrieve |
data | List to fill with table's columns contents |
Get an element's text
name | Name of the element |
text | The destination string |
richText | True to get the element's roch text if supported. |
virtual bool hasElement | ( | const String & | name | ) | [pure virtual] |
Check if this window has an element by name
name | Name of the element to search for |
Check if an element has an item by its name
name | Name of the element to search for |
item | Name of the item that should be searched |
virtual void hide | ( | ) | [pure virtual] |
Hide this window
const String& id | ( | ) | const [inline] |
Retrive the standard name of this Window
void init | ( | ) | [inline] |
Initialize the window if not already done
virtual bool insertTableRow | ( | const String & | name, |
const String & | item, | ||
const String & | before, | ||
const NamedList * | data = 0 |
||
) | [virtual] |
Insert a row into a table owned by this window
name | Name of the element |
item | Name of the item to insert |
before | Name of the item to insert before |
data | Table's columns to set |
static bool isValidParamPrefix | ( | const String & | prefix | ) | [static] |
Check if a string is a parameter prefix handled by setParams(). Exact prefix match is not a valid one
prefix | String to check |
bool master | ( | ) | const [inline] |
Check if this window is a master (topmost) window
virtual void move | ( | int | x, |
int | y | ||
) | [pure virtual] |
Move this window
x | The x coordinate of the upper left corner |
y | The y coordinate of the upper left corner |
virtual void moveRel | ( | int | dx, |
int | dy | ||
) | [pure virtual] |
Move this window related to its current position
dx | The value to be added to the current x coordinate of the upper left corner |
dy | The value to be added to the current y coordinate of the upper left corner |
void populate | ( | ) | [inline] |
Populate the window if not already done
bool popup | ( | ) | const [inline] |
Check if this window is a popup window
virtual bool related | ( | const Window * | wnd | ) | const [virtual] |
Checkes if this window is related to the given window
wnd | The window to check for any relation |
virtual bool setActive | ( | const String & | name, |
bool | active | ||
) | [pure virtual] |
Set an element as interactive in the window
name | Name of the element |
active | True to make interactive, false to disallow interaction |
virtual bool setCheck | ( | const String & | name, |
bool | checked | ||
) | [pure virtual] |
Set the checked or toggled status of an element in the window
name | Name of the element |
checked | True to make element checked or toggled |
virtual bool setFocus | ( | const String & | name, |
bool | select = false |
||
) | [pure virtual] |
Set an element as receiving input in the window
name | Name of the element |
select | Also select the content of the focused element |
virtual bool setMultipleRows | ( | const String & | name, |
const NamedList & | data, | ||
const String & | prefix = String::empty() |
||
) | [virtual] |
Append or update several table rows at once
name | Name of the element |
data | Parameters to initialize the rows with |
prefix | Prefix to match (and remove) in parameter names |
virtual void setOver | ( | const Window * | parent | ) | [pure virtual] |
Force this window on top of another one which becomes its parent
parent | Window to force as parent of this one |
virtual bool setParams | ( | const NamedList & | params | ) | [virtual] |
Set window parameters or widget contents
params | List of parameters to set in the window and its widgets |
virtual bool setProperty | ( | const String & | name, |
const String & | item, | ||
const String & | value | ||
) | [inline, virtual] |
Set a property for this window or for a widget owned by it
name | Name of the element |
item | Property's name |
value | Property's value |
Set the selection of an item in an element in the window
name | Name of the element |
item | Name of the item that should be selected |
virtual bool setShow | ( | const String & | name, |
bool | visible | ||
) | [pure virtual] |
Set the visibility of an element in the window
name | Name of the element |
visible | True to make element visible, false to hide it |
virtual bool setTableRow | ( | const String & | name, |
const String & | item, | ||
const NamedList * | data | ||
) | [virtual] |
Update a row from a table owned by this window
name | Name of the element |
item | Name of the item to update |
data | Data to update |
virtual bool setText | ( | const String & | name, |
const String & | text, | ||
bool | richText = false |
||
) | [pure virtual] |
Set the displayed text of an element in the window
name | Name of the element |
text | Text value to set in the element |
richText | True if the text contains format data |
virtual bool setUrgent | ( | const String & | name, |
bool | urgent | ||
) | [pure virtual] |
Flag an element as requiring immediate attention
name | Name of the element |
urgent | True if the element requires immediate attention |
virtual void show | ( | ) | [pure virtual] |
Show this window
virtual void size | ( | int | width, |
int | height | ||
) | [pure virtual] |
Resize this window
width | The new width |
height | The new width |
virtual const String& toString | ( | ) | const [virtual] |
Retrive the standard name of this Window, used to search in lists
Reimplemented from GenObject.
Referenced by ClientContact::isChatWnd(), and ClientContact::isChatWndPrefix().
virtual bool updateTableRow | ( | const String & | name, |
const String & | item, | ||
const NamedList * | data = 0 , |
||
bool | atStart = false |
||
) | [virtual] |
Set a table row or add a new one if not found
name | Name of the element |
item | Table item to set/add |
data | Optional list of parameters used to set row data |
atStart | True to add item at start, false to add them to the end |
virtual bool updateTableRows | ( | const String & | name, |
const NamedList * | data, | ||
bool | atStart = false |
||
) | [virtual] |
Add or set one or more table row(s). Screen update is locked while changing the table. Each data list element is a NamedPointer carrying a NamedList with item parameters. The name of an element is the item to update. Set element's value to boolean value 'true' to add a new item if not found or 'false' to set an existing one. Set it to empty string to delete the item
name | Name of the table |
data | The list of items to add/set/delete |
atStart | True to add new items at start, false to add them to the end |
void visible | ( | bool | yes | ) | [inline] |
Set the visibility status of this window
yes | True if window should be visible |
bool visible | ( | ) | const [inline] |
Get the visibility status of this window