IPanel Class Reference

Interface for panel-based UI components in the application. More...

#include <IPanel.h>

Inheritance diagram for IPanel:

Public Member Functions
virtual	~IPanel ()=default
virtual wxPanel *	GetPanel ()=0
	Returns the wxPanel used as the panel content.
virtual wxString	GetTitle () const =0
	Returns the display title of the panel.
virtual wxString	GetPanelType () const =0
	Returns the panel type identifier.
virtual void	Initialize ()
	Called once when the panel is first created.
virtual void	Refresh ()
	Refreshes the panel content.
virtual void	OnActivated ()
	Called when the panel becomes active.
virtual void	OnDeactivated ()
	Called when the panel becomes inactive.
virtual void	Cleanup ()
	Called to release resources when the panel is no longer needed.
virtual bool	IsValid () const
	Returns true if the panel is in a valid state.
virtual wxString	SerializeState () const
	Serializes panel state to a string for persistence.
virtual void	DeserializeState (const wxString &state)
	Restores panel state from a serialized string.
virtual bool	HasUnsavedChanges () const
	Returns true if the panel has unsaved changes.
virtual bool	Save ()
	Saves the panel content; returns true on success.
virtual bool	SupportsOperation (const wxString &operation) const
	Returns true if the panel supports the given operation.
virtual bool	ExecuteOperation (const wxString &operation, const wxString &parameter="")
	Executes an operation with optional parameter; returns true on success.

Detailed Description

Interface for panel-based UI components in the application.

Definition at line 7 of file IPanel.h.

Constructor & Destructor Documentation

~IPanel()

virtual IPanel::~IPanel ( )

virtualdefault

Member Function Documentation

Cleanup()

virtual void IPanel::Cleanup ( )

inlinevirtual

Called to release resources when the panel is no longer needed.

Reimplemented in EmberUI::Panel.

Definition at line 27 of file IPanel.h.

DeserializeState()

virtual void IPanel::DeserializeState ( const wxString & state )

inlinevirtual

Restores panel state from a serialized string.

Reimplemented in EmberUI::Panel.

Definition at line 35 of file IPanel.h.

ExecuteOperation()

virtual bool IPanel::ExecuteOperation ( const wxString & operation, const wxString & parameter = "" )

inlinevirtual

Executes an operation with optional parameter; returns true on success.

Reimplemented in EmberUI::Panel.

Definition at line 45 of file IPanel.h.

GetPanel()

virtual wxPanel * IPanel::GetPanel ( )

pure virtual

Returns the wxPanel used as the panel content.

Implemented in EmberUI::Panel.

GetPanelType()

virtual wxString IPanel::GetPanelType ( ) const

pure virtual

Returns the panel type identifier.

Implemented in BottomPanel, Ember::Monitor::RightSidePanel, EmberUI::Panel, LeftSidePanel, MainPanel, RightSidePanel, and SidePanel.

GetTitle()

virtual wxString IPanel::GetTitle ( ) const

pure virtual

Returns the display title of the panel.

Implemented in BottomPanel, Ember::Monitor::RightSidePanel, EmberUI::Panel, LeftSidePanel, MainPanel, RightSidePanel, and SidePanel.

HasUnsavedChanges()

virtual bool IPanel::HasUnsavedChanges ( ) const

inlinevirtual

Returns true if the panel has unsaved changes.

Reimplemented in EmberUI::Panel.

Definition at line 38 of file IPanel.h.

Initialize()

virtual void IPanel::Initialize ( )

inlinevirtual

Called once when the panel is first created.

Reimplemented in EmberUI::Panel.

Definition at line 19 of file IPanel.h.

IsValid()

virtual bool IPanel::IsValid ( ) const

inlinevirtual

Returns true if the panel is in a valid state.

Reimplemented in EmberUI::Panel.

Definition at line 30 of file IPanel.h.

OnActivated()

virtual void IPanel::OnActivated ( )

inlinevirtual

Called when the panel becomes active.

Reimplemented in EmberUI::Panel.

Definition at line 23 of file IPanel.h.

OnDeactivated()

virtual void IPanel::OnDeactivated ( )

inlinevirtual

Called when the panel becomes inactive.

Reimplemented in EmberUI::Panel.

Definition at line 25 of file IPanel.h.

Refresh()

virtual void IPanel::Refresh ( )

inlinevirtual

Refreshes the panel content.

Reimplemented in EmberUI::Panel.

Definition at line 21 of file IPanel.h.

Save()

virtual bool IPanel::Save ( )

inlinevirtual

Saves the panel content; returns true on success.

Reimplemented in EmberUI::Panel.

Definition at line 40 of file IPanel.h.

SerializeState()

virtual wxString IPanel::SerializeState ( ) const

inlinevirtual

Serializes panel state to a string for persistence.

Reimplemented in EmberUI::Panel.

Definition at line 33 of file IPanel.h.

SupportsOperation()

virtual bool IPanel::SupportsOperation ( const wxString & operation ) const

inlinevirtual

Returns true if the panel supports the given operation.

Reimplemented in EmberUI::Panel.

Definition at line 43 of file IPanel.h.

---

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

• EmberUI/include/Interfaces/IPanel.h