ITab Class Reference

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

#include <ITab.h>

Inheritance diagram for ITab:

Public Member Functions
virtual	~ITab ()=default
virtual wxWindow *	GetWidget ()=0
	Returns the wxWidgets window used as the tab content.
virtual wxString	GetTitle () const =0
	Returns the display title of the tab.
virtual wxString	GetTabType () const =0
	Returns the tab type identifier.
virtual wxBitmap	GetIcon () const
	Returns the tab icon bitmap; defaults to null.
virtual void	Initialize ()
	Called once when the tab is first created.
virtual void	Refresh ()
	Refreshes the tab content.
virtual void	OnActivated ()
	Called when the tab becomes active.
virtual void	OnDeactivated ()
	Called when the tab becomes inactive.
virtual void	OnClosed ()
	Called when the tab is closed.
virtual bool	IsValid () const
	Returns true if the tab is in a valid state.
virtual bool	CanClose () const
	Returns true if the tab can be closed.
virtual bool	CanMove () const
	Returns true if the tab can be moved/reordered.
virtual wxString	SerializeState () const
	Serializes tab state to a string for persistence.
virtual void	DeserializeState (const wxString &state)
	Restores tab state from a serialized string.
virtual bool	HasUnsavedChanges () const
	Returns true if the tab has unsaved changes.
virtual bool	Save ()
	Saves the tab content; returns true on success.
virtual bool	SupportsOperation (const wxString &operation) const
	Returns true if the tab 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 tab-based UI components in the application.

Definition at line 7 of file ITab.h.

Constructor & Destructor Documentation

~ITab()

virtual ITab::~ITab ( )

virtualdefault

Member Function Documentation

CanClose()

virtual bool ITab::CanClose ( ) const

inlinevirtual

Returns true if the tab can be closed.

Reimplemented in FileExplorerTab.

Definition at line 34 of file ITab.h.

CanMove()

virtual bool ITab::CanMove ( ) const

inlinevirtual

Returns true if the tab can be moved/reordered.

Reimplemented in FileExplorerTab.

Definition at line 36 of file ITab.h.

DeserializeState()

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

inlinevirtual

Restores tab state from a serialized string.

Definition at line 41 of file ITab.h.

ExecuteOperation()

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

inlinevirtual

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

Definition at line 51 of file ITab.h.

GetIcon()

virtual wxBitmap ITab::GetIcon ( ) const

inlinevirtual

Returns the tab icon bitmap; defaults to null.

Reimplemented in FileExplorerTab.

Definition at line 18 of file ITab.h.

GetTabType()

virtual wxString ITab::GetTabType ( ) const

pure virtual

Returns the tab type identifier.

Implemented in Ember::Monitor::MonitorNavigatorTab, Ember::Monitor::PropertiesTab, EmberForge::LogTab, EmberForge::PerformancePanel, EmberUI::NavigatorTab, EmberUI::TreeHierarchyTab, FileExplorerTab, and PropertiesTab.

GetTitle()

virtual wxString ITab::GetTitle ( ) const

pure virtual

Returns the display title of the tab.

Implemented in Ember::Monitor::MonitorNavigatorTab, EmberForge::LogTab, EmberForge::PerformancePanel, EmberUI::NavigatorTab, EmberUI::PropertiesTabBase, EmberUI::TreeHierarchyTab, and FileExplorerTab.

GetWidget()

virtual wxWindow * ITab::GetWidget ( )

pure virtual

Returns the wxWidgets window used as the tab content.

Implemented in EmberForge::LogTab, EmberForge::PerformancePanel, EmberUI::NavigatorTab, EmberUI::PropertiesTabBase, EmberUI::TreeHierarchyTab, and FileExplorerTab.

HasUnsavedChanges()

virtual bool ITab::HasUnsavedChanges ( ) const

inlinevirtual

Returns true if the tab has unsaved changes.

Definition at line 44 of file ITab.h.

Initialize()

virtual void ITab::Initialize ( )

inlinevirtual

Called once when the tab is first created.

Reimplemented in EmberForge::LogTab, and FileExplorerTab.

Definition at line 21 of file ITab.h.

IsValid()

virtual bool ITab::IsValid ( ) const

inlinevirtual

Returns true if the tab is in a valid state.

Reimplemented in FileExplorerTab.

Definition at line 32 of file ITab.h.

OnActivated()

virtual void ITab::OnActivated ( )

inlinevirtual

Called when the tab becomes active.

Reimplemented in EmberForge::LogTab, EmberUI::NavigatorTab, and FileExplorerTab.

Definition at line 25 of file ITab.h.

OnClosed()

virtual void ITab::OnClosed ( )

inlinevirtual

Called when the tab is closed.

Reimplemented in EmberForge::LogTab, EmberUI::NavigatorTab, FileExplorerTab, and PropertiesTab.

Definition at line 29 of file ITab.h.

OnDeactivated()

virtual void ITab::OnDeactivated ( )

inlinevirtual

Called when the tab becomes inactive.

Reimplemented in EmberForge::LogTab, and FileExplorerTab.

Definition at line 27 of file ITab.h.

Refresh()

virtual void ITab::Refresh ( )

inlinevirtual

Refreshes the tab content.

Reimplemented in Ember::Monitor::PropertiesTab, EmberForge::LogTab, and FileExplorerTab.

Definition at line 23 of file ITab.h.

Save()

virtual bool ITab::Save ( )

inlinevirtual

Saves the tab content; returns true on success.

Definition at line 46 of file ITab.h.

SerializeState()

virtual wxString ITab::SerializeState ( ) const

inlinevirtual

Serializes tab state to a string for persistence.

Definition at line 39 of file ITab.h.

SupportsOperation()

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

inlinevirtual

Returns true if the tab supports the given operation.

Definition at line 49 of file ITab.h.

---

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

• EmberUI/include/Interfaces/ITab.h