cwidget  0.5.17
Classes | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | List of all members
cwidget::widgets::multiplex Class Reference

This widget displays exactly one of its children at once. More...

#include <multiplex.h>

Inheritance diagram for cwidget::widgets::multiplex:
cwidget::widgets::passthrough cwidget::widgets::container cwidget::widgets::widget

Public Member Functions

int width_request ()
 Returns the maximum width requested by any child. More...
 
int height_request (int width)
 Returns the maximum height requested by any child. More...
 
void destroy ()
 Destroys the visible representation of this widget and disconnects it from any children that it may have.
 
void layout_me ()
 
virtual widget_ref get_focus ()
 
widget_ref visible_widget ()
 
unsigned int num_children ()
 
unsigned int num_visible ()
 
virtual void paint (const style &st)
 Display this widget. More...
 
void dispatch_mouse (short id, int x, int y, int z, mmask_t bstate)
 
void show_all ()
 Display this widget and all its subwidgets. More...
 
void set_show_tabs (bool shown)
 
void add_widget (const widget_ref &widget)
 Add a title-less widget. More...
 
void add_widget (const widget_ref &widget, const std::wstring &title)
 
void add_widget_bare (widget &widget, const std::wstring &title)
 
void add_widget_after (const widget_ref &widget, const widget_ref &after)
 
void add_widget_after_bare (cwidget::widgets::widget &widget, cwidget::widgets::widget &after)
 
void add_widget_after (const widget_ref &widget, const widget_ref &after, const std::wstring &title)
 
void add_widget_after_bare (cwidget::widgets::widget &widget, cwidget::widgets::widget &after, const std::wstring &title)
 
void rem_widget (const widget_ref &widget)
 
void cycle_forward ()
 
void cycle_backward ()
 
- Public Member Functions inherited from cwidget::widgets::passthrough
widget_ref get_active_widget ()
 Return the currently "active" child of this container, or NULL. More...
 
virtual bool focus_me ()
 
virtual bool get_cursorvisible ()
 
virtual point get_cursorloc ()
 
- Public Member Functions inherited from cwidget::widgets::container
void add_visible_widget (const widget_ref &, bool visible)
 
void add_widget_bare (widget &w)
 
void add_visible_widget_bare (widget &w, bool visible)
 
void rem_widget_bare (widget &w)
 
- Public Member Functions inherited from cwidget::widgets::widget
void incref ()
 
void decref ()
 
void show ()
 
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)
 
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< multiplexcreate (bool show_tabs=false)
 
- Static Public Member Functions inherited from cwidget::widgets::widget
static void handle_pending_deletes ()
 

Public Attributes

sigc::signal0< void > cycled
 Emitted when the currently visible widget changes. 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
 

Protected Member Functions

bool winavail ()
 
 multiplex (bool _show_tabs)
 
- Protected Member Functions inherited from cwidget::widgets::passthrough
virtual bool handle_key (const config::key &k)
 Handles a keypress in this widget. More...
 
void defocus ()
 
void refocus ()
 
- 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
 

Detailed Description

This widget displays exactly one of its children at once.

Hiding a child will prevent it from appearing; showing a child will add it to the list of visible children, and make it the currently visible child if it isn't already.

An optional "tab bar" listing the children of the multiplexer can be activated using set_show_tabs.

This widget requests enough space for its largest visible child.

Member Function Documentation

◆ add_widget()

void cwidget::widgets::multiplex::add_widget ( const widget_ref widget)
virtual

Add a title-less widget.

Provided to implement a required function and for backwards compatibility; use of this routine is deprecated.

Implements cwidget::widgets::container.

References cwidget::toplevel::queuelayout(), and cwidget::toplevel::update().

Referenced by show_all().

◆ height_request()

int cwidget::widgets::multiplex::height_request ( int  width)
virtual

Returns the maximum height requested by any child.

Implements cwidget::widgets::widget.

◆ paint()

void cwidget::widgets::multiplex::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(), and cwidget::toplevel::queuelayout().

◆ show_all()

void cwidget::widgets::multiplex::show_all ( )
virtual

Display this widget and all its subwidgets.

Implements cwidget::widgets::container.

References add_widget(), cwidget::toplevel::queuelayout(), and cwidget::toplevel::update().

◆ width_request()

int cwidget::widgets::multiplex::width_request ( )
virtual

Returns the maximum width requested by any child.

Implements cwidget::widgets::widget.

Member Data Documentation

◆ cycled

sigc::signal0<void> cwidget::widgets::multiplex::cycled

Emitted when the currently visible widget changes.


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