NCBI C++ ToolKit
Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
CWindowManagerService Class Reference

Search Toolkit Book for CWindowManagerService

CWindowManagerService - standard implementation of IWindowManagerService interface built on CWindowManager class. More...

#include <gui/framework/window_manager_service_impl.hpp>

+ Inheritance diagram for CWindowManagerService:
+ Collaboration diagram for CWindowManagerService:

Public Member Functions

 CWindowManagerService ()
virtual ~CWindowManagerService ()
virtual void SetFrame (wxFrame *frame)
virtual void SetMenuService (IMenuService *service)
bool OnCommandEvent (wxCommandEvent &event)
IService implementation
virtual void InitService ()
virtual void ShutDownService ()
IWindowManagerService implementation


virtual CWindowManagerGetWindowManager ()
virtual void SetAdvisor (IWindowManagerAdvisor *advisor)
 the service does not assume ownership of the given object More...
virtual void AddClient (IWMClient &client, bool bFloat)
 places the given IWMClient in the Main Tabbed Pane in Window Manager More...
virtual wxFrame * MoveToFloatingFrame (IWMClient &client)
virtual void CloseClient (IWMClient &client)
 remove client(s) from Window Manager these functions do not disconnect clients from other services More...
virtual void CloseClients (const TClients &clients)
virtual void CloseAllClients ()
virtual void GetAllClients (TClients &clients)
 returns a list of all registered IWMClients More...
virtual IWMClientGetActiveClient ()
 returns Active client (i.e. client that has focus) More...
virtual void ActivateClient (IWMClient &client)
 makes client visible and focused More...
virtual void ActivateClients (TClients &clients)
 makes clients visible, make the first client in the given container focused More...
virtual void RegisterActiveClient (IWMClient &client)
virtual void UnRegisterActiveClient (IWMClient &client)
virtual void RaiseFloatingWindowsInZOrder ()
 Raise all floating windows to preserve/refresh z-order. More...
virtual void RaiseFloatingWindowsInZOrder (wxRect r)
 Raise all floating windows if they overlap with the provided wxREct. More...
virtual bool IsDragging () const
 Returns true if a drag operation is currently in progress. More...
virtual void RefreshClient (IWMClient &client)
 refresh client UI (title) More...
virtual void ApplyLayout (const objects::CUser_object &layout)
virtual objects::CUser_object * SaveLayout ()
 saves current window layout to CUser_object More...
virtual void LoadLayout (const objects::CUser_object &layout, IWMClientFactory &factory)
 creates a new window layout based on description in the given CUser_object creates clients using IWMClientFactory More...
IToolBarService implementation
virtual void AddToolBarFactory (IToolBarContributor *factory)
 the service assumes ownership of the given factory (will delete it) More...
virtual void DeleteToolBarFactory (IToolBarContributor *factory)
 forces deleting of the factory More...
virtual void AddToolBarContext (IToolBarContext *context)
 register toolbar context the service does NOT assume ownership of the context More...
virtual void RemoveToolBarContext (IToolBarContext *context)
 unregister toolbar context More...
IWindowManagerMenuListener implementation
virtual void UpdateMenuBar ()
virtual const wxMenu * GetMenu ()
 returns a menu (must be deleted by the caller) menu injections should follow a separator named "Contribs" More...
IRegSettings interface implementation
virtual void SetRegistryPath (const string &path)
virtual void LoadSettings ()
virtual void SaveSettings () const
- Public Member Functions inherited from CObject
 CObject (void)
 Constructor. More...
 CObject (const CObject &src)
 Copy constructor. More...
virtual ~CObject (void)
 Destructor. More...
CObjectoperator= (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 IWindowManagerService
virtual ~IWindowManagerService ()
- Public Member Functions inherited from IToolBarService
virtual ~IToolBarService ()
- Public Member Functions inherited from IService
virtual ~IService ()
- Public Member Functions inherited from IWindowManagerMenuListener
virtual ~IWindowManagerMenuListener ()
- Public Member Functions inherited from IMenuContributor
virtual ~IMenuContributor ()
- Public Member Functions inherited from IRegSettings
virtual ~IRegSettings ()

Protected Types

typedef map< string, intTTBNameToCount
typedef vector< IToolBarContributor * > TToolBarFactories
typedef set< IToolBarContext * > TToolBarContexts

Protected Member Functions

virtual void x_ShowToolBar (const string &name, bool show)
virtual void x_ShutDownToolBars ()
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...
- Protected Member Functions inherited from IMenuContributor
virtual const SwxMenuItemRecGetMenuDef () const
 simpler way to provide a static menu using macros defined earlier in this file More...

Protected Attributes

string m_RegPath
wxFrame * m_Frame
TToolBarFactories m_ToolBarFactories
TToolBarContexts m_ToolBarContexts
 holds registered toolbar contexts More...
TTBNameToCount m_TBNameToCount
 holds a map of toolbar names declared by registered contexts toolbar name -> context count More...

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< Uint8TCounter
 Counter type is CAtomiCounter. More...
typedef Uint8 TCount
 Alias for value type of counter. More...
- Public Types inherited from IWindowManagerService
typedef vector< IWMClient * > TClients
- 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...

Detailed Description

CWindowManagerService - standard implementation of IWindowManagerService interface built on CWindowManager class.

CWindowManagerService also implements IToolBarService.

CWindowManagerService implements IMenuContributor in order to be compatible with IMenuService. It also implements IWindowManagerMenuListener to allow CWindowManager to change menu dynamically when needed.

Definition at line 70 of file window_manager_service_impl.hpp.

The documentation for this class was generated from the following files:
Modified on Thu Nov 30 04:57:54 2023 by rev. 669887