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

This class is a visually transparent wrapper around another widget. More...

#include <transient.h>

Inheritance diagram for cwidget::widgets::transient:
cwidget::widgets::bin cwidget::widgets::passthrough cwidget::widgets::container cwidget::widgets::widget

Public Member Functions

int width_request ()
 
int height_request (int width)
 Calculate the desired height of the subwidget. More...
 
bool focus_me ()
 
bool handle_char (chtype ch)
 Destroy the transient. More...
 
- Public Member Functions inherited from cwidget::widgets::bin
void set_subwidget (const util::ref_ptr< widget > &w)
 
void set_subwidget (widget &w)
 
widget_ref get_subwidget ()
 
void destroy ()
 Destroys the visible representation of this widget and disconnects it from any children that it may have.
 
virtual void show_all ()
 Display this widget and all its subwidgets. More...
 
virtual void add_widget (const widget_ref &w)
 
virtual void rem_widget (const widget_ref &w)
 
widget_ref get_focus ()
 
void paint (const style &st)
 Display this widget. More...
 
- 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 void dispatch_mouse (short id, int x, int y, int z, mmask_t bstate)
 
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< transientcreate (const widget_ref &w=NULL)
 Create a new transient. More...
 
- Static Public Member Functions inherited from cwidget::widgets::widget
static void handle_pending_deletes ()
 

Protected Member Functions

 transient (const widget_ref &w)
 
- 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
 
- 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
 

Detailed Description

This class is a visually transparent wrapper around another widget.

It captures all keystrokes (preventing the subwidget from recieving them), and destroys itself upon receiving one.

Member Function Documentation

◆ create()

static util::ref_ptr<transient> cwidget::widgets::transient::create ( const widget_ref w = NULL)
inlinestatic

Create a new transient.

Parameters
wthe widget to place inside the transient wrapper.

References focus_me(), handle_char(), height_request(), and width_request().

◆ focus_me()

bool cwidget::widgets::transient::focus_me ( )
virtual
Returns
true: transients can always be focussed.

Reimplemented from cwidget::widgets::passthrough.

Referenced by create().

◆ handle_char()

bool cwidget::widgets::transient::handle_char ( chtype  ch)

Destroy the transient.

Returns
true.

References cwidget::widgets::bin::destroy().

Referenced by create().

◆ height_request()

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

Calculate the desired height of the subwidget.

Parameters
widththe width of this widget
Returns
the desired height

Implements cwidget::widgets::widget.

References cwidget::widgets::widget::height_request().

Referenced by create().

◆ width_request()

int cwidget::widgets::transient::width_request ( )
virtual
Returns
the desired width of the subwidget.

Implements cwidget::widgets::widget.

References cwidget::widgets::widget::width_request().

Referenced by create().


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