albaGUIMDIFrame Class Reference

#include <albaGUIMDIFrame.h>

Inheritance diagram for albaGUIMDIFrame:

Collaboration diagram for albaGUIMDIFrame:

Public Member Functions
	albaGUIMDIFrame (const wxString &title, const wxPoint &pos, const wxSize &size, long style=0)
	~albaGUIMDIFrame ()
void	SetListener (albaObserver *Listener)
albaGUIDockManager &	GetDockManager ()
void	OnQuit ()
void	AddDockPane (wxWindow *window, wxPaneInfo &pane_info, const wxString &menu=_("&View"), const wxString &subMenu=wxEmptyString)
void	RemoveDockPane (wxString pane_name)
void	ShowDockPane (wxString pane_name, bool show=true)
void	ShowDockPane (wxWindow *window, bool show=true)
bool	DockPaneIsShown (wxString pane_name)
bool	DockPaneIsShown (wxWindow *window)
void	Busy ()
void	Ready ()
void	ProgressBarShow ()
void	ProgressBarHide ()
void	ProgressBarSetVal (int progress)
int	ProgressBarGetStatus ()
void	ProgressBarSetText (wxString *msg)
void	RenderStart ()
void	RenderEnd ()

Protected Member Functions
void	OnMenu (wxCommandEvent &e)
void	OnMenuOp (wxCommandEvent &e)
void	OnMenuView (wxCommandEvent &e)
void	OnUpdateUI (wxUpdateUIEvent &e)
void	OnCloseWindow (wxCloseEvent &event)
void	OnSashDrag (wxSashEvent &event)
void	OnLayout (wxCommandEvent &event)
void	OnIdle (wxIdleEvent &event)
void	FreeMemorySizeOnIdle (wxIdleEvent &event)
void	OnDropFile (wxDropFilesEvent &event)
void	LayoutWindow ()
void	CreateStatusbar ()
void	OnMenuWizard (wxCommandEvent &e)

Protected Attributes
albaObserver *	m_Listener
bool *	m_Busy
wxPanel *	m_BusyPanel
wxStaticText *	m_BusyLabel
wxGauge *	m_Gauge
std::vector< int >	m_PBCalls
int	m_ID_PBCall
int	m_MemoryLimitAlert
bool	m_UserAlerted
albaGUIDockManager	m_DockManager

Detailed Description

Class Name: albaGUIMDIFrame.

Represents the main frame of a ALBA Application. On this frame they'll be plugged toolbars, panels, progress bar etc... Closing this frame is equal to close the application.

Definition at line 45 of file albaGUIMDIFrame.h.

Constructor & Destructor Documentation

albaGUIMDIFrame()

albaGUIMDIFrame::albaGUIMDIFrame	(	const wxString &	title,
		const wxPoint &	pos,
		const wxSize &	size,
		long	style = 0
	)

constructor.

~albaGUIMDIFrame()

albaGUIMDIFrame::~albaGUIMDIFrame

(

)

destructor.

Member Function Documentation

SetListener()

void albaGUIMDIFrame::SetListener ( albaObserver *  Listener )

inline

Set the listener object, i.e.

the object receiving events sent by this object

Definition at line 54 of file albaGUIMDIFrame.h.

GetDockManager()

albaGUIDockManager & albaGUIMDIFrame::GetDockManager ( )

inline

Retrieve the Docking Manager.

Definition at line 57 of file albaGUIMDIFrame.h.

OnQuit()

void albaGUIMDIFrame::OnQuit

(

)

must be called @ shutdown

AddDockPane()

void albaGUIMDIFrame::AddDockPane	(	wxWindow *	window,
		wxPaneInfo &	pane_info,
		const wxString &	menu = _("&View"),
		const wxString &	subMenu = wxEmptyString
	)

add a new Dockable Pane containing the given Window.

pane_info specify the Pane settings

RemoveDockPane()

void albaGUIMDIFrame::RemoveDockPane

(

wxString

pane_name

)

remove a Dockable Pane - the contained window is not destroyed

ShowDockPane() [1/2]

void albaGUIMDIFrame::ShowDockPane	(	wxString	pane_name,
		bool	show = true
	)

Show/Hide a Dockable Pane – the Pane is specified by name.

ShowDockPane() [2/2]

void albaGUIMDIFrame::ShowDockPane	(	wxWindow *	window,
		bool	show = true
	)

Show/Hide a Dockable Pane – the Pane is specified by content.

DockPaneIsShown() [1/2]

bool albaGUIMDIFrame::DockPaneIsShown

(

wxString

pane_name

)

tell if a given Dockable Pane is shown – the Paneis specified by name

DockPaneIsShown() [2/2]

bool albaGUIMDIFrame::DockPaneIsShown

(

wxWindow *

window

)

tell if a given Dockable Pane is shown – the Pane is specified by content

Busy()

void albaGUIMDIFrame::Busy

(

)

Show the 'Busy' text on the status bar.

Ready()

void albaGUIMDIFrame::Ready

(

)

End the progress.

ProgressBarShow()

void albaGUIMDIFrame::ProgressBarShow

(

)

Show the progress bar.

ProgressBarHide()

void albaGUIMDIFrame::ProgressBarHide

(

)

Hide the progress bar.

ProgressBarSetVal()

void albaGUIMDIFrame::ProgressBarSetVal

(

int

progress

)

Set the progress value for the progress bar.

ProgressBarGetStatus()

int albaGUIMDIFrame::ProgressBarGetStatus

(

)

Get the progress bar status.

ProgressBarSetText()

void albaGUIMDIFrame::ProgressBarSetText

(

wxString *

msg

)

Set the progress text for the progress bar.

RenderStart()

void albaGUIMDIFrame::RenderStart

(

)

Start rendering progress.

RenderEnd()

void albaGUIMDIFrame::RenderEnd

(

)

End rendering progress.

OnMenu()

void albaGUIMDIFrame::OnMenu ( wxCommandEvent &  e )

protected

Send the men event.

OnMenuOp()

void albaGUIMDIFrame::OnMenuOp ( wxCommandEvent &  e )

protected

Send the 'Operations' men event.

OnMenuView()

void albaGUIMDIFrame::OnMenuView ( wxCommandEvent &  e )

protected

Send the 'Views' men event.

OnUpdateUI()

void albaGUIMDIFrame::OnUpdateUI ( wxUpdateUIEvent &  e )

protected

Send the UI event.

OnCloseWindow()

void albaGUIMDIFrame::OnCloseWindow ( wxCloseEvent &  event )

protected

Send the MENU_FILE_QUIT event.

OnSashDrag()

void albaGUIMDIFrame::OnSashDrag ( wxSashEvent &  event )

protected

Redraw sash panels.

OnLayout()

void albaGUIMDIFrame::OnLayout ( wxCommandEvent &  event )

protected

Call LayoutWindow method.

OnIdle()

void albaGUIMDIFrame::OnIdle ( wxIdleEvent &  event )

protected

Update the memory status on the status bas.

FreeMemorySizeOnIdle()

void albaGUIMDIFrame::FreeMemorySizeOnIdle ( wxIdleEvent &  event )

protected

Update the memory status on the status bas , with information that needs to walk the heap (bad performances)

OnDropFile()

void albaGUIMDIFrame::OnDropFile ( wxDropFilesEvent &  event )

protected

Send an event to open the msf or zip file.

LayoutWindow()

void albaGUIMDIFrame::LayoutWindow ( )

protected

Redraw widgets on interface.

CreateStatusbar()

void albaGUIMDIFrame::CreateStatusbar ( )

protected

Create the status bar on main application frame.

OnMenuWizard()

void albaGUIMDIFrame::OnMenuWizard ( wxCommandEvent &  e )

protected

Send the 'Wizard' men event.

Member Data Documentation

m_Listener

albaObserver* albaGUIMDIFrame::m_Listener

protected

Definition at line 172 of file albaGUIMDIFrame.h.

m_Busy

bool* albaGUIMDIFrame::m_Busy

protected

Definition at line 175 of file albaGUIMDIFrame.h.

m_BusyPanel

wxPanel* albaGUIMDIFrame::m_BusyPanel

protected

Definition at line 176 of file albaGUIMDIFrame.h.

m_BusyLabel

wxStaticText* albaGUIMDIFrame::m_BusyLabel

protected

Definition at line 177 of file albaGUIMDIFrame.h.

m_Gauge

wxGauge* albaGUIMDIFrame::m_Gauge

protected

Definition at line 178 of file albaGUIMDIFrame.h.

m_PBCalls

std::vector<int> albaGUIMDIFrame::m_PBCalls

protected

Definition at line 179 of file albaGUIMDIFrame.h.

m_ID_PBCall

int albaGUIMDIFrame::m_ID_PBCall

protected

Definition at line 180 of file albaGUIMDIFrame.h.

m_MemoryLimitAlert

int albaGUIMDIFrame::m_MemoryLimitAlert

protected

Used to alert the user when memory decrease under this limit value.

Definition at line 182 of file albaGUIMDIFrame.h.

m_UserAlerted

bool albaGUIMDIFrame::m_UserAlerted

protected

Definition at line 183 of file albaGUIMDIFrame.h.

m_DockManager

albaGUIDockManager albaGUIMDIFrame::m_DockManager

protected

Definition at line 186 of file albaGUIMDIFrame.h.

---

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

• albaGUIMDIFrame.h