Nana C++ Library. Reference for users.
What we need to use nana
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
nana::form Class Reference
Inheritance diagram for nana::form:
nana::drawerbase::form::form_base nana::widget_object< category::root_tag, drawerbase::form::trigger, detail::events_root_extension > nana::detail::widget_base nana::widget nana::inputbox_window

Public Types

using appear = ::nana::appear
 helper template class for creating the appearance of the form. More...
 
- Public Types inherited from nana::widget_object< category::root_tag, drawerbase::form::trigger, detail::events_root_extension >
using scheme_type = ::nana::widget_geometrics
 
using event_type = detail::events_root_extension
 
- Public Types inherited from nana::widget
using native_string_type = detail::native_string_type
 

Public Member Functions

 form (const rectangle &=API::make_center(300, 200), const appearance &={})
 Creates a window form owned by the desktop, at the point and size specified by rect, and with the specified appearance. More...
 
 form (window owner, const ::nana::size &={300, 200}, const appearance &={})
 Creates a window always floating above its owner at the point and size specified by rect, with the specified appearance. This window is always floating above its owner. More...
 
 form (window owner, const rectangle &, const appearance &={})
 
 form (const form &, const ::nana::size &={300, 200}, const appearance &={})
 
void modality () const
 Blocks the execution and other windows' messages until this window is closed. More...
 
void wait_for_this ()
 Blocks the execution until this window is closed. More...
 
void keyboard_accelerator (const accel_key &, const std::function< void()> &fn)
 
- Public Member Functions inherited from nana::drawerbase::form::form_base
 form_base (window owner, bool nested, const rectangle &, const appearance &)
 
placeget_place ()
 
void div (std::string div_text)
 
place::field_reference operator[] (const char *field_name)
 
void collocate () noexcept
 
- Public Member Functions inherited from nana::widget_object< category::root_tag, drawerbase::form::trigger, detail::events_root_extension >
 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::root_tag, drawerbase::form::trigger, detail::events_root_extension >
typedef drawerbase::form::trigger drawer_trigger_t
 
- Protected Member Functions inherited from nana::widget_object< category::root_tag, drawerbase::form::trigger, detail::events_root_extension >
drawerbase::form::triggerget_drawer_trigger ()
 
const drawerbase::form::triggerget_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

Member Typedef Documentation

helper template class for creating the appearance of the form.

Constructor & Destructor Documentation

nana::form::form ( const rectangle r = API::make_center(300, 200),
const appearance apr = {} 
)
explicit

Creates a window form owned by the desktop, at the point and size specified by rect, and with the specified appearance.

nana::form::form ( window  owner,
const ::nana::size sz = { 300, 200 },
const appearance apr = {} 
)
explicit

Creates a window always floating above its owner at the point and size specified by rect, with the specified appearance. This window is always floating above its owner.

nana::form::form ( window  owner,
const rectangle r,
const appearance apr = {} 
)
explicit
nana::form::form ( const form fm,
const ::nana::size sz = { 300, 200 },
const appearance apr = {} 
)

Member Function Documentation

void nana::form::keyboard_accelerator ( const accel_key key,
const std::function< void()> &  fn 
)
void nana::form::modality ( ) const

Blocks the execution and other windows' messages until this window is closed.

Examples:
menu_debug.cpp.
void nana::form::wait_for_this ( )

Blocks the execution until this window is closed.