Search Toolkit Book for CSelectionView

#include "selection_view.hpp"
(Private to src/gui/core.)

Inheritance diagram for CSelectionView:

Collaboration diagram for CSelectionView:

Public Member Functions
	CSelectionView ()

virtual	~CSelectionView ()

IView
virtual const CViewTypeDescriptor &	GetTypeDescriptor () const
	IView interface implementation. 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 ()
	IWMClient interface implementation. More...

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

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

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 &aColor)
	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 &aRootMenu)

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

IRegSettings interface implementation
virtual void	SetRegistryPath (const string &reg_path)
	IRegSettings interface implementation. More...

virtual void	LoadSettings ()

virtual void	SaveSettings () const

ISelectionClient interface implementation
virtual void	GetSelection (TConstScopedObjects &objects) const
	shall return data objects representing selected things, return one data object for every selected thing. More...

virtual void	SetSelectionService (ISelectionService *service)

virtual string	GetSelClientLabel ()
	returns a string identifying the client in UI More...

virtual void	GetSelection (CSelectionEvent &evt) const
	get selection for broadcasting More...

virtual void	SetSelection (CSelectionEvent &evt)
	set broadcasted selection More...

virtual void	GetMainObject (TConstScopedObjects &objects) const
	Adds the main data objects represented by the client to "objects". More...

Public Member Functions inherited from CObjectEx
	CObjectEx (void)

virtual	~CObjectEx (void)

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 CWeakObject
	CWeakObject (void)

virtual	~CWeakObject (void)

CPtrToObjectProxy *	GetPtrProxy (void) const
	Get pointer to proxy object containing pointer to this object. More...

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 ()

Public Member Functions inherited from CEventHandler
	CEventHandler ()
	CEventHandler. More...

virtual	~CEventHandler ()

virtual void	AddListener (CEventHandler *listener, int pool_name=ePool_Default)
	Add a listener. More...

virtual void	RemoveListener (CEventHandler *listener)
	Remove a listener. More...

virtual void	RemoveAllListeners (void)

virtual bool	HasListener (CEventHandler *listener, int pool_name=ePool_Default) const
	returns "true" if the given listener belongs to the specified pool More...

virtual const TListeners *	GetListeners (int pool_name=ePool_Default) const
	returns a set of listeners fro the specified pool More...

virtual bool	OnEvent (CEvent *evt)
	Processes en event. Returns "true" if event has been processed. More...

virtual bool	Dispatch (CEvent *evt, EDispatch disp_how=eDispatch_Default, int pool_name=ePool_Default)
	Dispatches an event to the listeners (but does not handle it). More...

virtual bool	Send (CEvent *evt, EDispatch disp_how=eDispatch_Default, int pool_name=ePool_Default)
	Sends an event synchronously. More...

virtual bool	Send (CEvent *evt, int pool_name)

void	Post (CRef< CEvent > evt, EDispatch disp_how=eDispatch_Default, int pool_name=ePool_Default)
	Handles an event asynchronously (process and/or dispatch). More...

Public Member Functions inherited from IRegSettings
virtual	~IRegSettings ()

Public Member Functions inherited from ISelectionClient
virtual	~ISelectionClient ()

virtual void	GetActiveObjects (TConstScopedObjects &objects) const

virtual void	GetActiveObjects (vector< TConstScopedObjects > &sel)
	Prioritized active objects. More...

virtual void	BroadcastSelection ()

Protected Member Functions
void	x_OnSelectionEvent (CEvent *)

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

Protected Member Functions inherited from CWeakObject
void	CleanWeakRefs (void) const
	Method cleaning all CWeakRefs referencing at this moment to the object After calling to this method all existing CWeakRefs referencing to the object will return NULL, so it effectively will be equal to deleting the 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...

Protected Member Functions inherited from CEventHandler
virtual const SEvtMap *	GetEventMap () const

void	x_DeclareDead ()
	Removes itself unavailable for async event delivery. More...

void	x_AddListenerToPool (CEventHandler *listener, int pool_name)

Protected Attributes
CSelectionService *	m_Service

bool	m_Broadcasting

CSelectionPanel *	m_Panel

Protected Attributes inherited from CEventHandler
TPools	m_Pools

Static Protected Attributes
static CViewTypeDescriptor	m_TypeDescr

Static Protected Attributes inherited from CEventHandler
static const SEvtMap	sm_EvtMap

Private Member Functions
	DECLARE_EVENT_MAP ()

	CSelectionView (const CSelectionView &)

CSelectionView &	operator= (const CSelectionView &)

Friends
class	CSelectionViewFactory

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...

Public Types inherited from CEventHandler
enum	EDispatch { eDispatch_SelfOnly , eDispatch_AllHandlers , eDispatch_FirstHandler , eDispatch_Default = eDispatch_AllHandlers }
	enum controlling dispatching strategies More...

enum	EPoolName { ePool_Default = 0 , ePool_Parent , ePool_Child , ePool_Sibling , ePool_NextAvailable }
	Identifiers for standard pools. More...

typedef vector< CEventHandler * >	TListeners

typedef map< int, TListeners >	TPools

typedef list< AutoPtr< SPostRequest > >	TPostRequests

typedef std::map< CEventHandler *, int >	THandlerToCount

typedef void(*	FOnPostCallback) ()

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 Member Functions inherited from CEventHandler
static bool	HandlePostRequest ()

static void	ClearPostQueue ()
	erases all events from the queue More...

static void	DestroyPostQueue ()

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...

Detailed Description

CSelectionView.

Definition at line 51 of file selection_view.hpp.

Constructor & Destructor Documentation

◆ CSelectionView() [1/2]

CSelectionView::CSelectionView ( )

◆ ~CSelectionView()

CSelectionView::~CSelectionView ( )

virtual

Definition at line 78 of file selection_view.cpp.

References NULL, and SetWorkbench().

◆ CSelectionView() [2/2]

CSelectionView::CSelectionView ( const CSelectionView & )

private

Member Function Documentation

◆ CreateViewWindow()

void CSelectionView::CreateViewWindow ( wxWindow * parent )

virtual

create Window corresponding to the view

Implements IView.

Definition at line 119 of file selection_view.cpp.

References CSelectionPanel::Create(), m_Panel, and wxID_ANY.

◆ DECLARE_EVENT_MAP()

CSelectionView::DECLARE_EVENT_MAP ( )

private

◆ DestroyViewWindow()

void CSelectionView::DestroyViewWindow ( )

virtual

destroy Window corresponding to the view

Implements IView.

Definition at line 126 of file selection_view.cpp.

References CSelectionPanel::Destroy(), m_Panel, and NULL.

◆ GetClientLabel()

string CSelectionView::GetClientLabel ( IWMClient::ELabel ltype = IWMClient::eDefault ) const

virtual

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

Implements IWMClient.

Definition at line 143 of file selection_view.cpp.

References CUIObject::GetLabel(), and m_TypeDescr.

◆ GetColor()

const CRgbaColor * CSelectionView::GetColor ( ) const

virtual

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

Implements IWMClient.

Definition at line 155 of file selection_view.cpp.

References NULL.

◆ GetCommandHandler()

virtual wxEvtHandler* CSelectionView::GetCommandHandler ( )

inlinevirtual

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

Implements IWMClient.

Definition at line 76 of file selection_view.hpp.

References GetWindow().

◆ GetFingerprint()

IWMClient::CFingerprint CSelectionView::GetFingerprint ( ) const

virtual

returns a fingerprint identifying the client

Implements IWMClient.

Definition at line 178 of file selection_view.cpp.

References CUIObject::GetLabel(), and m_TypeDescr.

◆ GetIconAlias()

string CSelectionView::GetIconAlias ( ) const

virtual

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

Implements IWMClient.

Definition at line 149 of file selection_view.cpp.

References CUIObject::GetIconAlias(), and m_TypeDescr.

◆ GetMainObject()

void CSelectionView::GetMainObject ( TConstScopedObjects & objects ) const

virtual

Adds the main data objects represented by the client to "objects".

Implementation shall not clear the container as it can be used for accumulating objects.

Implements ISelectionClient.

Definition at line 246 of file selection_view.cpp.

◆ GetMenu()

const wxMenu * CSelectionView::GetMenu ( void )

virtual

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

Reimplemented from IMenuContributor.

Definition at line 167 of file selection_view.cpp.

References NULL.

◆ GetSelClientLabel()

string CSelectionView::GetSelClientLabel ( )

virtual

returns a string identifying the client in UI

Implements ISelectionClient.

Definition at line 217 of file selection_view.cpp.

◆ GetSelection() [1/2]

void CSelectionView::GetSelection ( CSelectionEvent & evt ) const

virtual

get selection for broadcasting

Implements ISelectionClient.

Definition at line 223 of file selection_view.cpp.

References CSelectionEvent::AddObjectSelection(), GetSelection(), and ITERATE.

◆ GetSelection() [2/2]

void CSelectionView::GetSelection ( TConstScopedObjects & objects ) const

virtual

shall return data objects representing selected things, return one data object for every selected thing.

Implementation shall not clear the container as it can be used for accumulating objects.

Implements ISelectionClient.

Definition at line 204 of file selection_view.cpp.

References buf, CSelectionPanel::GetSelection(), and m_Panel.

Referenced by GetSelection().

◆ GetTypeDescriptor()

const CViewTypeDescriptor & CSelectionView::GetTypeDescriptor ( ) const

virtual

IView interface implementation.

Implements IView.

Definition at line 86 of file selection_view.cpp.

References m_TypeDescr.

◆ GetWindow()

wxWindow * CSelectionView::GetWindow ( )

virtual

IWMClient interface implementation.

Implements IWMClient.

Definition at line 137 of file selection_view.cpp.

References m_Panel.

Referenced by GetCommandHandler().

◆ LoadSettings()

void CSelectionView::LoadSettings ( )

virtual

Implements IRegSettings.

Definition at line 198 of file selection_view.cpp.

References CSelectionPanel::LoadSettings(), and m_Panel.

◆ operator=()

CSelectionView& CSelectionView::operator= ( const CSelectionView & )

private

◆ SaveSettings()

void CSelectionView::SaveSettings ( ) const

virtual

Implements IRegSettings.

Definition at line 192 of file selection_view.cpp.

References m_Panel, and CSelectionPanel::SaveSettings().

◆ SetColor()

void CSelectionView::SetColor ( const CRgbaColor & color )

virtual

returns a color associated with the client

Implements IWMClient.

Definition at line 161 of file selection_view.cpp.

◆ SetRegistryPath()

void CSelectionView::SetRegistryPath ( const string & reg_path )

virtual

IRegSettings interface implementation.

Implements IRegSettings.

Definition at line 187 of file selection_view.cpp.

References m_Panel, and CSelectionPanel::SetRegistryPath().

◆ SetSelection()

void CSelectionView::SetSelection ( CSelectionEvent & evt )

virtual

set broadcasted selection

Implements ISelectionClient.

Definition at line 240 of file selection_view.cpp.

◆ SetSelectionService()

void CSelectionView::SetSelectionService ( ISelectionService * service )

virtual

Implements ISelectionClient.

Definition at line 210 of file selection_view.cpp.

References m_Service.

◆ SetWorkbench()

void CSelectionView::SetWorkbench ( IWorkbench * workbench )

virtual

connect / disconnect this view with / from Workbench

Implements IView.

Definition at line 92 of file selection_view.cpp.

References CEventHandler::AddListener(), IServiceLocator::GetServiceByType(), m_Panel, m_Service, CEventHandler::RemoveListener(), and CSelectionPanel::SetSelectionService().

Referenced by ~CSelectionView().

◆ UpdateMenu()

void CSelectionView::UpdateMenu ( wxMenu & aRootMenu )

virtual

Definition at line 173 of file selection_view.cpp.

◆ x_OnSelectionEvent()

void CSelectionView::x_OnSelectionEvent ( CEvent * evt )

protected

Definition at line 110 of file selection_view.cpp.

References m_Panel, CSelectionPanel::OnSelServiceStateChange(), and CSelectionPanel::Update().

Friends And Related Function Documentation

◆ CSelectionViewFactory

friend class CSelectionViewFactory

friend

Definition at line 59 of file selection_view.hpp.

Member Data Documentation

◆ m_Broadcasting

bool CSelectionView::m_Broadcasting

protected

Definition at line 112 of file selection_view.hpp.

◆ m_Panel

CSelectionPanel* CSelectionView::m_Panel

protected

Definition at line 114 of file selection_view.hpp.

Referenced by CreateViewWindow(), DestroyViewWindow(), GetSelection(), GetWindow(), LoadSettings(), SaveSettings(), SetRegistryPath(), SetWorkbench(), and x_OnSelectionEvent().

◆ m_Service

CSelectionService* CSelectionView::m_Service

protected

Definition at line 110 of file selection_view.hpp.

Referenced by SetSelectionService(), and SetWorkbench().

◆ m_TypeDescr

CViewTypeDescriptor CSelectionView::m_TypeDescr

staticprotected

Definition at line 109 of file selection_view.hpp.

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

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

src/gui/core/selection_view.hpp
src/gui/core/selection_view.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CSelectionView() [1/2]

◆ ~CSelectionView()

◆ CSelectionView() [2/2]

Member Function Documentation

◆ CreateViewWindow()

◆ DECLARE_EVENT_MAP()

◆ DestroyViewWindow()

◆ GetClientLabel()

◆ GetColor()

◆ GetCommandHandler()

◆ GetFingerprint()

◆ GetIconAlias()

◆ GetMainObject()

◆ GetMenu()

◆ GetSelClientLabel()

◆ GetSelection() [1/2]

◆ GetSelection() [2/2]

◆ GetTypeDescriptor()

◆ GetWindow()

◆ LoadSettings()

◆ operator=()

◆ SaveSettings()

◆ SetColor()

◆ SetRegistryPath()

◆ SetSelection()

◆ SetSelectionService()

◆ SetWorkbench()

◆ UpdateMenu()

◆ x_OnSelectionEvent()

Friends And Related Function Documentation

◆ CSelectionViewFactory

Member Data Documentation

◆ m_Broadcasting

◆ m_Panel

◆ m_Service

◆ m_TypeDescr