#include <gui/framework/demo/test_views.hpp>

Inheritance diagram for CwxGLTestView:

Collaboration diagram for CwxGLTestView:

Public Member Functions
	CwxGLTestView ()

IView interface implementation
virtual const CViewTypeDescriptor &	GetTypeDescriptor () const
	return an object providing meta information about thei view type More...

virtual void	SetWorkbench (IWorkbench *workbench)
	connect / disconnect this view with / from Workbench More...

virtual void	CreateViewWindow (wxWindow *parent)
	create Window corresponding to the view More...

virtual void	DestroyViewWindow ()
	destroy Window corresponding to the view More...

IWMClient interface implementation
virtual wxWindow *	GetWindow ()
	returns a pointer to the wxWindow representing the client More...

virtual wxEvtHandler *	GetCommandHandler ()
	returns a pointer to the command handler (for menu commands and updates) More...

virtual string	GetClientLabel (IWMClient::ELabel ltype) const
	returns the client label (name) to be displayed in UI More...

virtual string	GetClientLabel () const

virtual string	GetIconAlias () const
	returns an icon alias that can be used to retrieve the client's icon More...

virtual const CRgbaColor *	GetColor () const
	returns a color associated with the client, n/a if NULL More...

virtual void	SetColor (const CRgbaColor &color)
	returns a color associated with the client More...

virtual const wxMenu *	GetMenu ()
	returns a menu (must be deleted by the caller) menu injections should follow a separator named "Contribs" More...

virtual void	UpdateMenu (wxMenu &root_menu)

virtual CFingerprint	GetFingerprint () const
	returns a fingerprint identifying the client More...

Public Member Functions inherited from CObject
	CObject (void)
	Constructor. More...

	CObject (const CObject &src)
	Copy constructor. More...

virtual	~CObject (void)
	Destructor. More...

CObject &	operator= (const CObject &src) THROWS_NONE
	Assignment operator. More...

bool	CanBeDeleted (void) const THROWS_NONE
	Check if object can be deleted. More...

bool	IsAllocatedInPool (void) const THROWS_NONE
	Check if object is allocated in memory pool (not system heap) More...

bool	Referenced (void) const THROWS_NONE
	Check if object is referenced. More...

bool	ReferencedOnlyOnce (void) const THROWS_NONE
	Check if object is referenced only once. More...

void	AddReference (void) const
	Add reference to object. More...

void	RemoveReference (void) const
	Remove reference to object. More...

void	ReleaseReference (void) const
	Remove reference without deleting object. More...

virtual void	DoNotDeleteThisObject (void)
	Mark this object as not allocated in heap – do not delete this object. More...

virtual void	DoDeleteThisObject (void)
	Mark this object as allocated in heap – object can be deleted. More...

void *	operator new (size_t size)
	Define new operator for memory allocation. More...

void *	operator new[] (size_t size)
	Define new[] operator for 'array' memory allocation. More...

void	operator delete (void *ptr)
	Define delete operator for memory deallocation. More...

void	operator delete[] (void *ptr)
	Define delete[] operator for memory deallocation. More...

void *	operator new (size_t size, void *place)
	Define new operator. More...

void	operator delete (void ptr, void place)
	Define delete operator. More...

void *	operator new (size_t size, CObjectMemoryPool *place)
	Define new operator using memory pool. More...

void	operator delete (void ptr, CObjectMemoryPool place)
	Define delete operator. More...

virtual void	DebugDump (CDebugDumpContext ddc, unsigned int depth) const
	Define method for dumping debug information. More...

Public Member Functions inherited from CDebugDumpable
	CDebugDumpable (void)

virtual	~CDebugDumpable (void)

void	DebugDumpText (ostream &out, const string &bundle, unsigned int depth) const

void	DebugDumpFormat (CDebugDumpFormatter &ddf, const string &bundle, unsigned int depth) const

void	DumpToConsole (void) const

Public Member Functions inherited from IView
virtual	~IView ()

Public Member Functions inherited from IWMClient
virtual void	SetFingerprint (const string &)

virtual bool	IsAForm () const
	returns true if client is a Form - wants to be sized to its client area (like a dialog) More...

virtual bool	IsADialog () const
	returns true if client is a non-modal dioalog More...

virtual	~IWMClient ()

Public Member Functions inherited from IMenuContributor
virtual	~IMenuContributor ()

Protected Attributes
CGLTestWMClient *	m_Client

Static Protected Attributes
static CViewTypeDescriptor	m_TypeDescr
	CwxGLTestView. More...

Friends
class	CwxGLTestViewFactory

Additional Inherited Members
Public Types inherited from CObject
enum	EAllocFillMode { eAllocFillNone = 1 , eAllocFillZero , eAllocFillPattern }
	Control filling of newly allocated memory. More...

typedef CObjectCounterLocker	TLockerType
	Default locker type for CRef. More...

typedef atomic< Uint8 >	TCounter
	Counter type is CAtomiCounter. More...

typedef Uint8	TCount
	Alias for value type of counter. More...

Public Types inherited from IWMClient
enum	ELabel { eContent , eTypeAndContent , eDetailed , eDefault = eDetailed }
	Different flavors of label types for different GUI aspects. More...

Static Public Member Functions inherited from CObject
static NCBI_XNCBI_EXPORT void	ThrowNullPointerException (void)
	Define method to throw null pointer exception. More...

static NCBI_XNCBI_EXPORT void	ThrowNullPointerException (const type_info &type)

static EAllocFillMode	GetAllocFillMode (void)

static void	SetAllocFillMode (EAllocFillMode mode)

static void	SetAllocFillMode (const string &value)
	Set mode from configuration parameter value. More...

Static Public Member Functions inherited from CDebugDumpable
static void	EnableDebugDump (bool on)

Static Public Attributes inherited from CObject
static const TCount	eCounterBitsCanBeDeleted = 1 << 0
	Define possible object states. More...

static const TCount	eCounterBitsInPlainHeap = 1 << 1
	Heap signature was found. More...

static const TCount	eCounterBitsPlaceMask
	Mask for 'in heap' state flags. More...

static const int	eCounterStep = 1 << 2
	Skip over the "in heap" bits. More...

static const TCount	eCounterValid = TCount(1) << (sizeof(TCount) * 8 - 2)
	Minimal value for valid objects (reference counter is zero) Must be a single bit value. More...

static const TCount	eCounterStateMask
	Valid object, and object in heap. More...

Protected Member Functions inherited from CObject
virtual void	DeleteThis (void)
	Virtual method "deleting" this object. More...

Protected Member Functions inherited from IMenuContributor
virtual const SwxMenuItemRec *	GetMenuDef () const
	simpler way to provide a static menu using macros defined earlier in this file More...

Detailed Description

CwxGLTestView.

Definition at line 47 of file test_views.hpp.

Constructor & Destructor Documentation

◆ CwxGLTestView()

CwxGLTestView::CwxGLTestView ( )

Definition at line 49 of file test_views.cpp.

Member Function Documentation

◆ CreateViewWindow()

void CwxGLTestView::CreateViewWindow ( wxWindow * parent )

virtual

create Window corresponding to the view

Implements IView.

Definition at line 66 of file test_views.cpp.

References m_Client.

◆ DestroyViewWindow()

void CwxGLTestView::DestroyViewWindow ( )

virtual

destroy Window corresponding to the view

Implements IView.

Definition at line 72 of file test_views.cpp.

References m_Client, and NULL.

◆ GetClientLabel() [1/2]

string CwxGLTestView::GetClientLabel ( ) const

virtual

Definition at line 91 of file test_views.cpp.

References CUIObject::GetLabel(), and m_TypeDescr.

◆ GetClientLabel() [2/2]

string CwxGLTestView::GetClientLabel ( IWMClient::ELabel ltype ) const

virtual

returns the client label (name) to be displayed in UI

Implements IWMClient.

Definition at line 86 of file test_views.cpp.

◆ GetColor()

const CRgbaColor * CwxGLTestView::GetColor ( ) const

virtual

returns a color associated with the client, n/a if NULL

Implements IWMClient.

Definition at line 103 of file test_views.cpp.

References CGLTestWMClient::GetColor(), and m_Client.

◆ GetCommandHandler()

virtual wxEvtHandler* CwxGLTestView::GetCommandHandler ( )

inlinevirtual

returns a pointer to the command handler (for menu commands and updates)

Implements IWMClient.

Definition at line 67 of file test_views.hpp.

References GetWindow().

◆ GetFingerprint()

IWMClient::CFingerprint CwxGLTestView::GetFingerprint ( ) const

virtual

returns a fingerprint identifying the client

Implements IWMClient.

Definition at line 127 of file test_views.cpp.

References CUIObject::GetLabel(), and m_TypeDescr.

◆ GetIconAlias()

string CwxGLTestView::GetIconAlias ( ) const

virtual

returns an icon alias that can be used to retrieve the client's icon

Implements IWMClient.

Definition at line 97 of file test_views.cpp.

References CUIObject::GetIconAlias(), and m_TypeDescr.

◆ GetMenu()

const wxMenu * CwxGLTestView::GetMenu ( )

virtual

returns a menu (must be deleted by the caller) menu injections should follow a separator named "Contribs"

Reimplemented from IMenuContributor.

Definition at line 115 of file test_views.cpp.

References CGLTestWMClient::GetMenu(), and m_Client.

◆ GetTypeDescriptor()

const CViewTypeDescriptor & CwxGLTestView::GetTypeDescriptor ( ) const

virtual

return an object providing meta information about thei view type

Implements IView.

Definition at line 55 of file test_views.cpp.

References m_TypeDescr.

◆ GetWindow()

wxWindow * CwxGLTestView::GetWindow ( )

virtual

returns a pointer to the wxWindow representing the client

Implements IWMClient.

Definition at line 81 of file test_views.cpp.

References m_Client.

Referenced by GetCommandHandler().

◆ SetColor()

void CwxGLTestView::SetColor ( const CRgbaColor & color )

virtual

returns a color associated with the client

Implements IWMClient.

Definition at line 109 of file test_views.cpp.

References color, m_Client, and CGLTestWMClient::SetColor().

◆ SetWorkbench()

void CwxGLTestView::SetWorkbench ( IWorkbench * workbench )

virtual

connect / disconnect this view with / from Workbench

Implements IView.

Definition at line 61 of file test_views.cpp.

◆ UpdateMenu()

void CwxGLTestView::UpdateMenu ( wxMenu & root_menu )

virtual

Definition at line 121 of file test_views.cpp.

References m_Client, and CGLTestWMClient::UpdateMenu().

Friends And Related Function Documentation

◆ CwxGLTestViewFactory

friend class CwxGLTestViewFactory

friend

Definition at line 52 of file test_views.hpp.

Member Data Documentation

◆ m_Client

CGLTestWMClient* CwxGLTestView::m_Client

protected

Definition at line 81 of file test_views.hpp.

Referenced by CreateViewWindow(), DestroyViewWindow(), GetColor(), GetMenu(), GetWindow(), SetColor(), and UpdateMenu().

◆ m_TypeDescr

CViewTypeDescriptor CwxGLTestView::m_TypeDescr

staticprotected

CwxGLTestView.

Definition at line 80 of file test_views.hpp.

Referenced by CwxGLTestViewFactory::CreateInstanceByFingerprint(), GetClientLabel(), GetFingerprint(), GetIconAlias(), GetTypeDescriptor(), and CwxGLTestViewFactory::GetViewTypeDescriptor().

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

include/gui/framework/demo/test_views.hpp
src/gui/framework/demo/test_views.cpp

Public Member Functions

Protected Attributes

Static Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CwxGLTestView()

Member Function Documentation

◆ CreateViewWindow()

◆ DestroyViewWindow()

◆ GetClientLabel() [1/2]

◆ GetClientLabel() [2/2]

◆ GetColor()

◆ GetCommandHandler()

◆ GetFingerprint()

◆ GetIconAlias()

◆ GetMenu()

◆ GetTypeDescriptor()

◆ GetWindow()

◆ SetColor()

◆ SetWorkbench()

◆ UpdateMenu()

Friends And Related Function Documentation

◆ CwxGLTestViewFactory

Member Data Documentation

◆ m_Client

◆ m_TypeDescr