neoGFX
Cross-platform C++ app/game engine
•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages Concepts
Public Types | Public Member Functions | List of all members
neogfx::i_dockable Class Referenceabstract

#include <i_dockable.hpp>

Inheritance diagram for neogfx::i_dockable:
neogfx::i_tool neolib::i_reference_counted neogfx::i_standard_layout_container neogfx::i_skinnable_item

Public Types

typedef i_dockable abstract_type
 

Public Member Functions

 declare_event (docked, i_dock &) declare_event(undocked
 
virtual ~i_dockable ()=default
 
virtual bool can_dock (const i_dock &aDock) const =0
 
virtual bool is_docked () const =0
 
virtual const i_dock & which_dock () const =0
 
virtual i_dock & which_dock ()=0
 
virtual void dock (i_dock &aDock)=0
 
virtual void undock ()=0
 
virtual const i_widget & docked_widget () const =0
 
virtual i_widget & docked_widget ()=0
 
- Public Member Functions inherited from neogfx::i_tool
virtual ~i_tool ()=default
 
virtual const neolib::i_string & title () const =0
 
virtual bool is_widget () const=0
 
virtual const i_widget & as_widget () const=0
 
virtual i_widget & as_widget ()=0
 
- Public Member Functions inherited from neogfx::i_standard_layout_container
virtual ~i_standard_layout_container ()=default
 
virtual bool has_client_widget () const =0
 
virtual const i_widget & client_widget () const =0
 
virtual i_widget & client_widget ()=0
 
virtual void set_client (i_widget &aClient)=0
 
virtual void set_client (i_ref_ptr< i_widget > const &aClient)=0
 
virtual const i_title_bar & title_bar () const =0
 
virtual i_title_bar & title_bar ()=0
 
virtual void set_title_bar (i_title_bar &aTitleBar)=0
 
virtual void set_title_bar (i_ref_ptr< i_title_bar > const &aTitleBar)=0
 
virtual const i_status_bar & status_bar () const =0
 
virtual i_status_bar & status_bar ()=0
 
virtual void set_status_bar (i_status_bar &aStatusBar)=0
 
virtual void set_status_bar (i_ref_ptr< i_status_bar > const &aStatusBar)=0
 
virtual bool has_layout (standard_layout aStandardLayout) const =0
 
virtual const i_layout & layout (standard_layout aStandardLayout, layout_position aPosition=layout_position::None) const =0
 
virtual i_layout & layout (standard_layout aStandardLayout, layout_position aPosition=layout_position::None)=0
 
const i_layout & non_client_layout () const
 
i_layout & non_client_layout ()
 
const i_layout & title_bar_layout () const
 
i_layout & title_bar_layout ()
 
const i_layout & menu_layout () const
 
i_layout & menu_layout ()
 
const i_layout & toolbar_layout (layout_position aPosition=layout_position::Top) const
 
i_layout & toolbar_layout (layout_position aPosition=layout_position::Top)
 
const i_layout & dock_layout (layout_position aPosition=layout_position::Left) const
 
i_layout & dock_layout (layout_position aPosition=layout_position::Left)
 
const i_layout & dock_layout (dock_area aDockArea=dock_area::Left) const
 
i_layout & dock_layout (dock_area aDockArea=dock_area::Left)
 
const i_layout & client_layout () const
 
i_layout & client_layout ()
 
const i_layout & button_box_layout () const
 
i_layout & button_box_layout ()
 
const i_layout & status_bar_layout () const
 
i_layout & status_bar_layout ()
 
- Public Member Functions inherited from neogfx::i_skinnable_item
virtual ~i_skinnable_item ()=default
 
virtual rect element_rect (skin_element aElement) const =0
 
- Public Member Functions inherited from neolib::i_reference_counted
virtual ~i_reference_counted ()=default
 
virtual void add_ref () const noexcept=0
 
virtual void release () const =0
 
virtual int32_t use_count () const noexcept=0
 
virtual const i_reference_counted * release_and_take_ownership () const =0
 
virtual i_reference_counted * release_and_take_ownership ()=0
 
virtual void pin () const noexcept=0
 
virtual void unpin () const =0
 
virtual i_ref_control_block & control_block ()=0
 

Additional Inherited Members

- Static Public Member Functions inherited from neogfx::i_standard_layout_container
static layout_position to_position (dock_area aDockArea)
 

Detailed Description

Definition at line 33 of file i_dockable.hpp.

Member Typedef Documentation

◆ abstract_type

typedef i_dockable neogfx::i_dockable::abstract_type

Definition at line 39 of file i_dockable.hpp.

Constructor & Destructor Documentation

◆ ~i_dockable()

virtual neogfx::i_dockable::~i_dockable ( )
virtualdefault

Member Function Documentation

◆ can_dock()

virtual bool neogfx::i_dockable::can_dock ( const i_dock &  aDock) const
pure virtual

◆ declare_event()

neogfx::i_dockable::declare_event ( docked  ,
i_dock &   
)

◆ dock()

virtual void neogfx::i_dockable::dock ( i_dock &  aDock)
pure virtual

◆ docked_widget() [1/2]

virtual const i_widget & neogfx::i_dockable::docked_widget ( ) const
pure virtual

◆ docked_widget() [2/2]

virtual i_widget & neogfx::i_dockable::docked_widget ( )
pure virtual

◆ is_docked()

virtual bool neogfx::i_dockable::is_docked ( ) const
pure virtual

◆ undock()

virtual void neogfx::i_dockable::undock ( )
pure virtual

◆ which_dock() [1/2]

virtual const i_dock & neogfx::i_dockable::which_dock ( ) const
pure virtual

◆ which_dock() [2/2]

virtual i_dock & neogfx::i_dockable::which_dock ( )
pure virtual
The documentation for this class was generated from the following file: