Boost.UI
User Interface Boost library
Public Member Functions | List of all members
boost::ui::frame Class Reference

Top level widget that hosts other widgets and supports menu bar. More...

Inheritance diagram for boost::ui::frame:
[legend]

Public Member Functions

ui::menu_bar menu_bar ()
 Returns menu bar. More...
 
ui::status_bar status_bar ()
 Returns status bar. More...
 
 frame (const uistring &title)
 Creates frame with the title.
 
framecreate (const uistring &title)
 Creates frame with the title.
 
- Public Member Functions inherited from boost::ui::window
windowtitle (const uistring &title)
 Sets title. More...
 
uistring title () const
 Returns title.
 
void show_modal ()
 Shows an application-modal dialog. More...
 
bool close ()
 Initiates window close. Returns false if operation was vetoed.
 
 BOOST_UI_DETAIL_HANDLER (close, window)
 Connects window close handler.
 
 BOOST_UI_DETAIL_HANDLER_EVENT (close_event, window, close_event)
 Connects window close handler.
 
- Public Member Functions inherited from boost::ui::widget
ui::layout::item layout ()
 Returns layout::item with this widget.
 
widgetresize (coord_type width, coord_type height)
 Changes widget size to specified values.
 
coord_type x () const
 Returns x coordinate relative to the parent widget client area.
 
coord_type y () const
 Returns y coordinate relative to the parent widget client area.
 
coord_type width () const
 Returns widget width.
 
coord_type height () const
 Returns widget height.
 
point pos () const
 Returns widget position relative to the parent widget client area.
 
size dimensions () const
 Returns widget size.
 
rect bounds () const
 Returns widget bounds in client coordinates.
 
widgetenable (bool do_enable=true)
 Enables widget if do_enable is true, disables otherwise.
 
widgetdisable ()
 Disables widget.
 
bool is_enabled () const
 Returns true if widget is enabled, false otherwise.
 
widgetshow (bool do_show=true)
 Shows widget if do_show is true, hides otherwise.
 
widgethide ()
 Hides widget.
 
bool is_shown () const
 Returns true if widget is shown on screen, false otherwise.
 
widgettooltip (const uistring &text)
 Sets tooltip text. More...
 
uistring tooltip () const
 Returns tooltip text.
 
widgetfont (const ui::font &f)
 Sets font.
 
ui::font font () const
 Returns font.
 
bool native_valid () const noexcept
 Returns true only if native widget was created.
 
widgetappend (const widget &w)
 Creates native widget and appends it to this widget.
 
widgetoperator<< (const widget &w)
 Creates native widget and appends it to this widget.
 
widgetmove (coord_type x, coord_type y)
 Moves widget to specified position.
 
widgetmove (const point &pos)
 Moves widget to specified position.
 
template<class F , class... Args>
widgeton_resize (F &&f, Args &&...args)
 Connects widget resize handler.
 
template<class F , class... Args>
widgeton_key_press (F &&f, Args &&...args)
 Connects keyboard event handler.
 
template<class F , class... Args>
widgeton_key_press_event (F &&f, Args &&...args)
 Connects keyboard event handler.
 
template<class F , class... Args>
widgeton_key_down (F &&f, Args &&...args)
 Connects keyboard event handler.
 
template<class F , class... Args>
widgeton_key_down_event (F &&f, Args &&...args)
 Connects keyboard event handler.
 
template<class F , class... Args>
widgeton_key_up (F &&f, Args &&...args)
 Connects keyboard event handler.
 
template<class F , class... Args>
widgeton_key_up_event (F &&f, Args &&...args)
 Connects keyboard event handler.
 
template<class F , class... Args>
widgeton_left_mouse_down (F &&f, Args &&...args)
 Connects mouse event handler.
 
template<class F , class... Args>
widgeton_left_mouse_down_event (F &&f, Args &&...args)
 Connects mouse event handler.
 
template<class F , class... Args>
widgeton_left_mouse_up (F &&f, Args &&...args)
 Connects mouse event handler.
 
template<class F , class... Args>
widgeton_left_mouse_up_event (F &&f, Args &&...args)
 Connects mouse event handler.
 
template<class F , class... Args>
widgeton_right_mouse_down (F &&f, Args &&...args)
 Connects mouse event handler.
 
template<class F , class... Args>
widgeton_right_mouse_down_event (F &&f, Args &&...args)
 Connects mouse event handler.
 
template<class F , class... Args>
widgeton_right_mouse_up (F &&f, Args &&...args)
 Connects mouse event handler.
 
template<class F , class... Args>
widgeton_right_mouse_up_event (F &&f, Args &&...args)
 Connects mouse event handler.
 
template<class F , class... Args>
widgeton_middle_mouse_down (F &&f, Args &&...args)
 Connects mouse event handler.
 
template<class F , class... Args>
widgeton_middle_mouse_down_event (F &&f, Args &&...args)
 Connects mouse event handler.
 
template<class F , class... Args>
widgeton_middle_mouse_up (F &&f, Args &&...args)
 Connects mouse event handler.
 
template<class F , class... Args>
widgeton_middle_mouse_up_event (F &&f, Args &&...args)
 Connects mouse event handler.
 
template<class F , class... Args>
widgeton_left_mouse_double_click (F &&f, Args &&...args)
 Connects mouse event handler.
 
template<class F , class... Args>
widgeton_left_mouse_double_click_event (F &&f, Args &&...args)
 Connects mouse event handler.
 
template<class F , class... Args>
widgeton_right_mouse_double_click (F &&f, Args &&...args)
 Connects mouse event handler.
 
template<class F , class... Args>
widgeton_right_mouse_double_click_event (F &&f, Args &&...args)
 Connects mouse event handler.
 
template<class F , class... Args>
widgeton_middle_mouse_double_click (F &&f, Args &&...args)
 Connects mouse event handler.
 
template<class F , class... Args>
widgeton_middle_mouse_double_click_event (F &&f, Args &&...args)
 Connects mouse event handler.
 
template<class F , class... Args>
widgeton_mouse_move (F &&f, Args &&...args)
 Connects mouse event handler.
 
template<class F , class... Args>
widgeton_mouse_move_event (F &&f, Args &&...args)
 Connects mouse event handler.
 
template<class F , class... Args>
widgeton_mouse_drag (F &&f, Args &&...args)
 Connects mouse event handler.
 
template<class F , class... Args>
widgeton_mouse_drag_event (F &&f, Args &&...args)
 Connects mouse event handler.
 
template<class F , class... Args>
widgeton_mouse_enter (F &&f, Args &&...args)
 Connects mouse event handler.
 
template<class F , class... Args>
widgeton_mouse_enter_event (F &&f, Args &&...args)
 Connects mouse event handler.
 
template<class F , class... Args>
widgeton_mouse_leave (F &&f, Args &&...args)
 Connects mouse event handler.
 
template<class F , class... Args>
widgeton_mouse_leave_event (F &&f, Args &&...args)
 Connects mouse event handler.
 
template<class F , class... Args>
widgeton_context_menu (F &&f, Args &&...args)
 Connects mouse event handler.
 
template<class F , class... Args>
widgeton_context_menu_event (F &&f, Args &&...args)
 Connects mouse event handler.
 
template<class F , class... Args>
widgeton_mouse_wheel (F &&f, Args &&...args)
 Connects mouse event handler.
 
template<class F , class... Args>
widgeton_mouse_wheel_event (F &&f, Args &&...args)
 Connects mouse event handler.
 
native_handle_type native_handle ()
 Returns the implementation-defined underlying widget handle.
 
const native_handle_type native_handle () const
 Returns the implementation-defined underlying widget handle.
 

Additional Inherited Members

- Public Types inherited from boost::ui::widget
typedef void * native_handle_type
 Implementation-defined widget type.
 

Detailed Description

Top level widget that hosts other widgets and supports menu bar.

Usage example:

class my_frame : public ui::frame
{
typedef my_frame this_type;
public:
my_frame() : ui::frame("Frame example")
{
ui::button(*this, "&Close this frame")
.on_press(&this_type::on_close, this);
<< ( ui::menu("&File")
<< ui::menu::item("&Quit")
.on_press(&this_type::on_close, this)
)
;
status_bar().text("Ready");
}
private:
void on_close()
{
close();
}
};
void run_frame()
{
my_frame().show_modal();
}
See also
Window (Wikipedia)

Member Function Documentation

ui::menu_bar boost::ui::frame::menu_bar ( )

Returns menu bar.

If menu bar wasn't created, creates menu bar.

ui::status_bar boost::ui::frame::status_bar ( )

Returns status bar.

If status bar wasn't created, creates status bar.


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