ALBA
Public Member Functions | Protected Attributes | Friends | List of all members
wxFrameManager Class Reference

#include <albaGUIDockManager.h>

Inheritance diagram for wxFrameManager:
Inheritance graph
[legend]
Collaboration diagram for wxFrameManager:
Collaboration graph
[legend]

Public Member Functions

 wxFrameManager (wxFrame *frame=NULL, unsigned int flags=wxAUI_MGR_DEFAULT)
 
virtual ~wxFrameManager ()
 
void UnInit ()
 
void SetFlags (unsigned int flags)
 
unsigned int GetFlags () const
 
void SetFrame (wxFrame *frame)
 
wxFrame * GetFrame () const
 
void SetArtProvider (wxDockArt *art_provider)
 
wxDockArt * GetArtProvider () const
 
wxPaneInfo & GetPane (wxWindow *window)
 
wxPaneInfo & GetPane (const wxString &name)
 
wxPaneInfoArray & GetAllPanes ()
 
virtual bool AddPane (wxWindow *window, const wxPaneInfo &pane_info)
 
virtual bool AddPane (wxWindow *window, int direction=wxLEFT, const wxString &caption=wxEmptyString)
 
bool InsertPane (wxWindow *window, const wxPaneInfo &pane_info, int insert_level=wxAUI_INSERT_PANE)
 
bool DetachPane (wxWindow *window)
 
wxString SavePerspective ()
 
bool LoadPerspective (const wxString &perspective, bool update=true)
 
virtual void Update ()
 

Protected Attributes

wxFrame * m_Frame
 
wxDockArt * m_Art
 
unsigned int m_Flags
 
wxPaneInfoArray m_PanesArray
 
wxDockInfoArray m_Docks
 
wxDockUIPartArray m_UIParts
 
int m_Action
 
wxPoint m_ActionStart
 
wxPoint m_ActionOffset
 
wxDockUIPart * m_ActionPart
 
wxWindow * m_ActionWindow
 
wxRect m_ActionHintRect
 
wxDockUIPart * m_HoverButton
 
wxRect m_LastHint
 
wxPoint m_LastMouseMove
 
wxWindow * m_HintWnd
 
wxTimer m_HintFadeTimer
 
int m_HintFadeAmount
 

Friends

class wxFloatingPane
 

Detailed Description

class name: wxFrameManager Manager for dockabale panels; it can manage flags, attach/detach panes.

Definition at line 425 of file albaGUIDockManager.h.

Constructor & Destructor Documentation

◆ wxFrameManager()

wxFrameManager::wxFrameManager ( wxFrame *  frame = NULL,
unsigned int  flags = wxAUI_MGR_DEFAULT 
)

constructor

◆ ~wxFrameManager()

virtual wxFrameManager::~wxFrameManager ( )
virtual

destructor

Member Function Documentation

◆ UnInit()

void wxFrameManager::UnInit ( )

remove event handler

◆ SetFlags()

void wxFrameManager::SetFlags ( unsigned int  flags)

set flags

◆ GetFlags()

unsigned int wxFrameManager::GetFlags ( ) const

retrieve flags

◆ SetFrame()

void wxFrameManager::SetFrame ( wxFrame *  frame)

set frame

◆ GetFrame()

wxFrame * wxFrameManager::GetFrame ( ) const

retrieve frame

◆ SetArtProvider()

void wxFrameManager::SetArtProvider ( wxDockArt *  art_provider)

set art provider

◆ GetArtProvider()

wxDockArt * wxFrameManager::GetArtProvider ( ) const

retrieve art provider

◆ GetPane() [1/2]

wxPaneInfo & wxFrameManager::GetPane ( wxWindow *  window)

retrieve pane from window

◆ GetPane() [2/2]

wxPaneInfo & wxFrameManager::GetPane ( const wxString &  name)

retrieve pane from name

◆ GetAllPanes()

wxPaneInfoArray & wxFrameManager::GetAllPanes ( )

retrieve all panes

◆ AddPane() [1/2]

virtual bool wxFrameManager::AddPane ( wxWindow *  window,
const wxPaneInfo &  pane_info 
)
virtual

add pane

◆ AddPane() [2/2]

virtual bool wxFrameManager::AddPane ( wxWindow *  window,
int  direction = wxLEFT,
const wxString &  caption = wxEmptyString 
)
virtual

add pane

Reimplemented in albaGUIDockManager.

◆ InsertPane()

bool wxFrameManager::InsertPane ( wxWindow *  window,
const wxPaneInfo &  pane_info,
int  insert_level = wxAUI_INSERT_PANE 
)

insert pane, shifting the panes around, depending on the insert level

◆ DetachPane()

bool wxFrameManager::DetachPane ( wxWindow *  window)

detach pane

◆ SavePerspective()

wxString wxFrameManager::SavePerspective ( )

saves all pane information as a single string

◆ LoadPerspective()

bool wxFrameManager::LoadPerspective ( const wxString &  perspective,
bool  update = true 
)

load perspective from a string

◆ Update()

virtual void wxFrameManager::Update ( )
virtual

update

Reimplemented in albaGUIDockManager.

Friends And Related Function Documentation

◆ wxFloatingPane

friend class wxFloatingPane
friend

Definition at line 427 of file albaGUIDockManager.h.

Member Data Documentation

◆ m_Frame

wxFrame* wxFrameManager::m_Frame
protected

Definition at line 608 of file albaGUIDockManager.h.

◆ m_Art

wxDockArt* wxFrameManager::m_Art
protected

Definition at line 609 of file albaGUIDockManager.h.

◆ m_Flags

unsigned int wxFrameManager::m_Flags
protected

Definition at line 610 of file albaGUIDockManager.h.

◆ m_PanesArray

wxPaneInfoArray wxFrameManager::m_PanesArray
protected

Definition at line 612 of file albaGUIDockManager.h.

◆ m_Docks

wxDockInfoArray wxFrameManager::m_Docks
protected

Definition at line 613 of file albaGUIDockManager.h.

◆ m_UIParts

wxDockUIPartArray wxFrameManager::m_UIParts
protected

Definition at line 614 of file albaGUIDockManager.h.

◆ m_Action

int wxFrameManager::m_Action
protected

Definition at line 616 of file albaGUIDockManager.h.

◆ m_ActionStart

wxPoint wxFrameManager::m_ActionStart
protected

Definition at line 617 of file albaGUIDockManager.h.

◆ m_ActionOffset

wxPoint wxFrameManager::m_ActionOffset
protected

Definition at line 618 of file albaGUIDockManager.h.

◆ m_ActionPart

wxDockUIPart* wxFrameManager::m_ActionPart
protected

Definition at line 619 of file albaGUIDockManager.h.

◆ m_ActionWindow

wxWindow* wxFrameManager::m_ActionWindow
protected

Definition at line 620 of file albaGUIDockManager.h.

◆ m_ActionHintRect

wxRect wxFrameManager::m_ActionHintRect
protected

Definition at line 621 of file albaGUIDockManager.h.

◆ m_HoverButton

wxDockUIPart* wxFrameManager::m_HoverButton
protected

Definition at line 622 of file albaGUIDockManager.h.

◆ m_LastHint

wxRect wxFrameManager::m_LastHint
protected

Definition at line 623 of file albaGUIDockManager.h.

◆ m_LastMouseMove

wxPoint wxFrameManager::m_LastMouseMove
protected

Definition at line 624 of file albaGUIDockManager.h.

◆ m_HintWnd

wxWindow* wxFrameManager::m_HintWnd
protected

Definition at line 626 of file albaGUIDockManager.h.

◆ m_HintFadeTimer

wxTimer wxFrameManager::m_HintFadeTimer
protected

Definition at line 627 of file albaGUIDockManager.h.

◆ m_HintFadeAmount

int wxFrameManager::m_HintFadeAmount
protected

Definition at line 628 of file albaGUIDockManager.h.

The documentation for this class was generated from the following file:
Generated by doxygen 1.9.5