cwidget  0.5.17
Classes | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | List of all members
cwidget::widgets::tree Class Reference
Inheritance diagram for cwidget::widgets::tree:
cwidget::widgets::widget

Public Member Functions

void set_root (treeitem *_root, bool showroot=false)
 
int width_request ()
 
int height_request (int w)
 
bool get_cursorvisible ()
 
point get_cursorloc ()
 
virtual bool focus_me ()
 
virtual void paint (const style &st)
 Display this widget. More...
 
virtual void dispatch_mouse (short id, int x, int y, int z, mmask_t bstate)
 
void set_selection (treeiterator to, bool force_to_top=false)
 Directly sets the selection to the given element. More...
 
treeiterator get_selection () const
 Retrieve a reference to the currently selected entry in the tree. More...
 
treeiterator get_begin ()
 Retrieve an iterator referencing the start of the tree. More...
 
treeiterator get_end ()
 Retrieve an iterator referencing the end of the tree. More...
 
void search_for (tree_search_func &matches)
 
void search_for (const std::wstring &s)
 
void search_back_for (tree_search_func &matches)
 
void search_back_for (const std::wstring &s)
 
void set_hierarchical (bool _hierarchical)
 
bool get_hierarchical ()
 
void highlight_current ()
 Send a 'highlighted' message to the currently selected item. More...
 
void unhighlight_current ()
 Send an 'unhighlighted' message to the currently selected item. More...
 
void line_up ()
 
void line_down ()
 
void page_up ()
 
void page_down ()
 
void jump_to_begin ()
 
void jump_to_end ()
 
void level_line_up ()
 
void level_line_down ()
 
- Public Member Functions inherited from cwidget::widgets::widget
void incref ()
 
void decref ()
 
void show ()
 
virtual void show_all ()
 
void hide ()
 
void toggle_visible ()
 
void set_visible (bool _visible)
 
bool dispatch_key (const config::key &k)
 
void alloc_size (int x, int y, int w, int h)
 Set the size and location in the parent of this widget. More...
 
bool get_isfocussed ()
 
void set_owner (container *w)
 
void display (const style &st)
 Display this widget in the given style environment. More...
 
int timeout (int msecs)
 
virtual void destroy ()
 Destroys the visible representation of this widget and disconnects it from any children that it may have.
 
util::ref_ptr< containerget_owner ()
 
int get_startx ()
 
int get_starty ()
 
int get_width ()
 
int get_height ()
 
bool get_visible ()
 
void sync ()
 
int scroll (int n=1)
 
int addch (chtype ch)
 
int mvaddch (int y, int x, chtype ch)
 
int add_wch (wchar_t wch)
 
int add_wch (const cchar_t *cch)
 
int mvadd_wch (int y, int x, wchar_t wch)
 
int mvadd_wch (int y, int x, const cchar_t *cch)
 
int addstr (const char *str)
 
int addnstr (const char *str, int n)
 
int mvaddstr (int y, int x, const char *str)
 
int mvaddnstr (int y, int x, const char *str, int n)
 
int addstr (const wchar_t *str)
 
int addnstr (const wchar_t *str, int n)
 
int mvaddstr (int y, int x, const wchar_t *str)
 
int mvaddnstr (int y, int x, const wchar_t *str, int n)
 
int addstr (const std::wstring &str)
 
int addnstr (const std::wstring &str, int n)
 
int mvaddstr (int y, int x, const std::wstring &str)
 
int mvaddnstr (int y, int x, const std::wstring &str, int n)
 
int addstr (const wchstring &str)
 
int addnstr (const wchstring &str, int n)
 
int mvaddstr (int y, int x, const wchstring &str)
 
int mvaddnstr (int y, int x, const wchstring &str, int n)
 
int addstr (const chstring &str)
 
int addnstr (const chstring &str, int n)
 
int mvaddstr (int y, int x, const chstring &str)
 
int mvaddnstr (int y, int x, const chstring &str, int n)
 
int attroff (int attrs)
 
int attron (int attrs)
 
int attrset (int attrs)
 
void bkgdset (const chtype ch)
 
int bkgd (const chtype ch)
 
chtype getbkgd ()
 
int border (chtype ls, chtype rs, chtype ts, chtype bs, chtype tl, chtype tr, chtype bl, chtype br)
 
int box (chtype verch, chtype horch)
 
int hline (chtype ch, int n)
 
int vline (chtype ch, int n)
 
int mvhline (int y, int x, chtype ch, int n)
 
int mvvline (int y, int x, chtype ch, int n)
 
int delch ()
 
int mvdelch (int y, int x)
 
int deleteln ()
 
int insdelln (int n)
 
int insertln ()
 
int echochar (chtype ch)
 
int move (int y, int x)
 
void getyx (int &y, int &x)
 
void getbegyx (int &y, int &x)
 
void getmaxyx (int &y, int &x)
 
int getmaxy ()
 
int getmaxx ()
 
void show_string_as_progbar (int x, int y, const std::wstring &s, const style &st1, const style &st2, int size1, int totalsize)
 
void display_header (std::wstring s, const style &st)
 
void display_status (std::wstring s, const style &st)
 
int erase ()
 
int clear ()
 
int clrtobot ()
 
int clrtoeol ()
 
int keypad (bool bf)
 
int meta (bool bf)
 
bool enclose (int y, int x)
 
void set_opaque (bool opaque)
 Enable or disable clearing the background before displaying the widget. More...
 
void set_bg_style (const style &new_style)
 Update this widget's basic style to the given value. More...
 
void apply_style (const style &st)
 Set the display attributes of our associated window directly from the given style. More...
 
key_connection connect_key (const std::string &key, config::keybindings *bindings, const sigc::slot0< void > &slot)
 
key_connection connect_key_post (const std::string &key, config::keybindings *bindings, const sigc::slot0< void > &slot)
 
void disconnect_key (key_connection c)
 
void disconnect_key_post (key_connection c)
 

Static Public Member Functions

static util::ref_ptr< treecreate ()
 
static util::ref_ptr< treecreate (treeitem *root, bool showroot=false)
 
static void init_bindings ()
 
- Static Public Member Functions inherited from cwidget::widgets::widget
static void handle_pending_deletes ()
 

Public Attributes

sigc::signal1< void, treeitem * > selection_changed
 Emitted when the selection moves to a new item. More...
 
- Public Attributes inherited from cwidget::widgets::widget
sigc::signal0< void > shown_sig
 
sigc::signal0< void > hidden_sig
 
sigc::signal0< void > destroyed
 
sigc::signal0< void > do_layout
 
sigc::signal0< void > focussed
 
sigc::signal0< void > unfocussed
 

Static Public Attributes

static config::keybindingsbindings =NULL
 

Protected Member Functions

void sync_bounds ()
 
virtual bool handle_key (const config::key &k)
 Handles a keypress in this widget. More...
 
 tree (treeitem *_root, bool showroot)
 
- Protected Member Functions inherited from cwidget::widgets::widget
cwindow get_win ()
 
void cleanup ()
 Handle cleanup when the reference count goes to 0. More...
 

Additional Inherited Members

- Public Types inherited from cwidget::widgets::widget
typedef std::list< binding_connection >::iterator key_connection
 

Member Function Documentation

◆ get_begin()

treeiterator cwidget::widgets::tree::get_begin ( )
inline

Retrieve an iterator referencing the start of the tree.

◆ get_end()

treeiterator cwidget::widgets::tree::get_end ( )
inline

Retrieve an iterator referencing the end of the tree.

◆ get_selection()

treeiterator cwidget::widgets::tree::get_selection ( ) const
inline

Retrieve a reference to the currently selected entry in the tree.

This iterator might be invalidated by user interactions and should not be saved.

◆ handle_key()

bool cwidget::widgets::tree::handle_key ( const config::key k)
protectedvirtual

Handles a keypress in this widget.

Parameters
kthe key that was pressed (see keybindings.h).
Returns
true if the key was consumed; if false is returned, further processing of the key will be performed.

Reimplemented from cwidget::widgets::widget.

References cwidget::widgets::widget::handle_key(), and cwidget::toplevel::update().

◆ height_request()

int cwidget::widgets::tree::height_request ( int  w)
virtual
Parameters
wthe width of the widget.
Returns
the desired height of the widget for the given width.

Implements cwidget::widgets::widget.

References cwidget::toplevel::update().

◆ highlight_current()

void cwidget::widgets::tree::highlight_current ( )

Send a 'highlighted' message to the currently selected item.

◆ paint()

void cwidget::widgets::tree::paint ( const style st)
virtual

Display this widget.

Parameters
stthe style environment in which the widget is to be displayed.

Implements cwidget::widgets::widget.

References cwidget::widgets::widget::apply_style(), cwidget::get_style(), cwidget::config::global_bindings, and cwidget::widgets::treeitem::paint().

◆ set_selection()

void cwidget::widgets::tree::set_selection ( treeiterator  to,
bool  force_to_top = false 
)

Directly sets the selection to the given element.

Parameters
toThe element to select.
force_to_topIf true, the element will be placed at the top of the list if the list scrolls.

If the element's parents are not currently expanded, they will be immediately expanded.

References cwidget::widgets::treeitem::highlighted_changed, and cwidget::toplevel::update().

◆ unhighlight_current()

void cwidget::widgets::tree::unhighlight_current ( )

Send an 'unhighlighted' message to the currently selected item.

References cwidget::widgets::treeitem::highlighted_changed, and cwidget::toplevel::update().

◆ width_request()

int cwidget::widgets::tree::width_request ( )
virtual
Returns
the desired width of the widget.

Implements cwidget::widgets::widget.

Member Data Documentation

◆ selection_changed

sigc::signal1<void, treeitem *> cwidget::widgets::tree::selection_changed

Emitted when the selection moves to a new item.

The item will be NULL if nothing is selected. The signal will also be emitted when the widget is shown/hidden and when the


The documentation for this class was generated from the following files: