Nana C++ Library. Reference for users.
What we need to use nana
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
nana::toolbar Class Reference

Control bar that contains buttons for controlling. More...

Inheritance diagram for nana::toolbar:
nana::widget_object< category::widget_tag, drawerbase::toolbar::drawer, drawerbase::toolbar::toolbar_events > nana::detail::widget_base nana::widget

Public Types

using size_type = std::size_t
 A type to count the number of elements. More...
 
using tool_type = drawerbase::toolbar::tool_type
 
- Public Types inherited from nana::widget_object< category::widget_tag, drawerbase::toolbar::drawer, drawerbase::toolbar::toolbar_events >
using scheme_type = ::nana::widget_geometrics
 
using event_type = drawerbase::toolbar::toolbar_events
 
- Public Types inherited from nana::widget
using native_string_type = detail::native_string_type
 

Public Member Functions

 toolbar ()=default
 
 toolbar (window, bool visible, bool detached=false)
 
 toolbar (window, const rectangle &=rectangle(), bool visible=true, bool detached=false)
 
void separate ()
 Adds a separator. More...
 
drawerbase::toolbar::item_proxy append (const ::std::string &text, const nana::paint::image &img)
 Adds a control button. More...
 
drawerbase::toolbar::item_proxy append (const ::std::string &text)
 Adds a control button. More...
 
void clear ()
 Removes all control buttons and separators. More...
 
bool enable (size_type index) const
 
void enable (size_type index, bool enable_state)
 
void tooltype (size_type index, tool_type type)
 Sets the tool style. More...
 
bool istoggle (size_type index) const
 Returns true if the tool style is toggle. More...
 
bool toggle (size_type index) const
 Gets the tool toggle state (only if tool style is toggle). More...
 
void toggle (size_type index, bool toggle_state)
 Sets the tool toggle state (only if tool style is toggle). More...
 
std::string toggle_group (size_type index) const
 Returns the toggle group associated with the tool (only if tool style is toggle). More...
 
void toggle_group (size_type index, const ::std::string &group)
 Adds the tool to a toggle group (only if tool style is toggle). More...
 
void textout (size_type index, bool show)
 Show/Hide the text inside the button. More...
 
void scale (unsigned s)
 Sets the scale of control button. More...
 
void go_right ()
 Enable to place buttons at right part. After calling it, every new button is right aligned. More...
 
bool detached ()
 
- Public Member Functions inherited from nana::widget_object< category::widget_tag, drawerbase::toolbar::drawer, drawerbase::toolbar::toolbar_events >
 widget_object ()
 
 ~widget_object ()
 
event_typeevents () const
 
bool create (window parent_wd, bool visible)
 
bool create (window parent_wd, const rectangle &r={}, bool visible=true)
 
widget_objectborderless (bool enable)
 
bool borderless () const
 
scheme_typescheme () const
 
void filter_event (const event_code evt_code, const bool bDisabled)
 
void filter_event (const std::vector< event_code > evt_codes, const bool bDisabled)
 
void filter_event (const event_filter_status &evt_all_states)
 
bool filter_event (const event_code evt_code)
 
event_filter_status filter_event ()
 
void clear_filter ()
 
- Public Member Functions inherited from nana::detail::widget_base
window handle () const override
 Returns the handle of window, returns 0 if window is not created. More...
 
- Public Member Functions inherited from nana::widget
 widget ()=default
 
virtual ~widget ()=default
 
bool empty () const
 Determines whether the manipulator is handling a window. More...
 
void close ()
 
window parent () const
 
::std::string caption () const noexcept
 
::std::wstring caption_wstring () const noexcept
 
native_string_type caption_native () const noexcept
 
widgetcaption (std::string utf8)
 
widgetcaption (std::wstring)
 
template<typename... Args>
void i18n (std::string msgid, Args &&...args)
 
void i18n (i18n_eval)
 
void cursor (nana::cursor)
 
nana::cursor cursor () const
 Retrieves the shape of cursor. More...
 
void typeface (const paint::font &font)
 
paint::font typeface () const
 
bool enabled () const
 Determines whether the window is enabled for mouse and keyboard input. More...
 
void enabled (bool)
 
void enable_dropfiles (bool)
 Enables/Disables a window to accept dropped files. More...
 
void focus ()
 
bool focused () const
 
std::shared_ptr
< scroll_operation_interface
scroll_operation ()
 
void show ()
 Sets the window visible. More...
 
void hide ()
 Sets the window invisible. More...
 
bool visible () const
 
nana::size size () const
 
void size (const nana::size &)
 
void set_capture (bool ignore_children)
 Enables the widget to grab the mouse input. More...
 
void release_capture ()
 Disables the widget to grab the mouse input. More...
 
point pos () const
 
void move (int x, int y)
 
void move (const point &)
 
void move (const rectangle &)
 
void fgcolor (const nana::color &)
 
nana::color fgcolor () const
 
void bgcolor (const nana::color &)
 
nana::color bgcolor () const
 
general_eventsevents () const
 
void umake_event (event_handle eh) const
 Deletes an event callback by a handle. More...
 
widgetregister_shortkey (wchar_t)
 Registers a shortkey. To remove a registered key, pass 0. More...
 
widgettake_active (bool activated, window take_if_not_activated)
 
widgettooltip (const ::std::string &)
 
 operator dummy_bool_type () const
 
 operator window () const
 

Additional Inherited Members

- Protected Types inherited from nana::widget_object< category::widget_tag, drawerbase::toolbar::drawer, drawerbase::toolbar::toolbar_events >
typedef drawerbase::toolbar::drawer drawer_trigger_t
 
- Protected Member Functions inherited from nana::widget_object< category::widget_tag, drawerbase::toolbar::drawer, drawerbase::toolbar::toolbar_events >
drawerbase::toolbar::drawerget_drawer_trigger ()
 
const drawerbase::toolbar::drawerget_drawer_trigger () const
 
- Protected Member Functions inherited from nana::widget
std::unique_ptr
<::nana::detail::widget_notifier_interface
_m_wdg_notifier ()
 
virtual void _m_complete_creation ()
 
virtual native_string_type _m_caption () const noexcept
 
virtual void _m_caption (native_string_type &&)
 
virtual nana::cursor _m_cursor () const
 
virtual void _m_cursor (nana::cursor)
 
virtual void _m_close ()
 
virtual bool _m_enabled () const
 
virtual void _m_enabled (bool)
 
virtual std::shared_ptr
< scroll_operation_interface
_m_scroll_operation ()
 
virtual bool _m_show (bool)
 
virtual bool _m_visible () const
 
virtual void _m_size (const nana::size &)
 
virtual void _m_move (int x, int y)
 
virtual void _m_move (const rectangle &)
 
virtual void _m_typeface (const nana::paint::font &font)
 
virtual nana::paint::font _m_typeface () const
 
virtual void _m_fgcolor (const nana::color &)
 
virtual nana::color _m_fgcolor () const
 
virtual void _m_bgcolor (const nana::color &)
 
virtual nana::color _m_bgcolor () const
 
- Protected Attributes inherited from nana::detail::widget_base
window handle_ { nullptr }
 

Detailed Description

Control bar that contains buttons for controlling.

Examples:
file_explorer.cpp.

Member Typedef Documentation

A type to count the number of elements.

Constructor & Destructor Documentation

nana::toolbar::toolbar ( )
default
nana::toolbar::toolbar ( window  wd,
bool  visible,
bool  detached = false 
)
nana::toolbar::toolbar ( window  wd,
const rectangle r = rectangle(),
bool  visible = true,
bool  detached = false 
)

Member Function Documentation

drawerbase::toolbar::item_proxy nana::toolbar::append ( const ::std::string text,
const nana::paint::image img 
)

Adds a control button.

drawerbase::toolbar::item_proxy nana::toolbar::append ( const ::std::string text)

Adds a control button.

void nana::toolbar::clear ( )

Removes all control buttons and separators.

bool nana::toolbar::detached ( )
inline
bool nana::toolbar::enable ( size_type  index) const
void nana::toolbar::enable ( size_type  index,
bool  enable_state 
)
void nana::toolbar::go_right ( )

Enable to place buttons at right part. After calling it, every new button is right aligned.

bool nana::toolbar::istoggle ( size_type  index) const

Returns true if the tool style is toggle.

void nana::toolbar::scale ( unsigned  s)

Sets the scale of control button.

void nana::toolbar::separate ( )

Adds a separator.

void nana::toolbar::textout ( size_type  index,
bool  show 
)

Show/Hide the text inside the button.

bool nana::toolbar::toggle ( size_type  index) const

Gets the tool toggle state (only if tool style is toggle).

void nana::toolbar::toggle ( size_type  index,
bool  toggle_state 
)

Sets the tool toggle state (only if tool style is toggle).

std::string nana::toolbar::toggle_group ( size_type  index) const

Returns the toggle group associated with the tool (only if tool style is toggle).

void nana::toolbar::toggle_group ( size_type  index,
const ::std::string group 
)

Adds the tool to a toggle group (only if tool style is toggle).

void nana::toolbar::tooltype ( size_type  index,
tool_type  type 
)

Sets the tool style.