CBCGPWorkspace

Detailed Description

The CBCGPWorkspace class provides the functionality of workspace manager. It handles the application/customization state, helps to save/load the state to/from the registry, contains initialization and access methods for the global managers such as CBCGPMouseManager, CBCGPContextMenuManager, CBCGPKeyboardManager, CBCGPUserToolsManager and CBCGPTearOffManager.

You can incorporate the CBCGPWorkspace functionality into your application by deriving the application class from it along with CWinApp, or by calling the CBCGPWorkspace::UseWorkspaceManager static member function.

Inheritance diagram for CBCGPWorkspace:

Public Member Functions
	CBCGPWorkspace	Constructs a CBCGPWorkspace object.
	CleanState	Removes the workspace state from the Windows registry.
	CreateScreenshot	Creates a given window screenshot.
	EnableLoadKeyboardAccelerators	Enables or disables loading of keyboard accelerators along with other settings.
	EnableLoadWindowPlacement	Enables or disables loading of main frame size and position along with other settings.
	EnableTaskBarInteraction	Enables interaction with Windows 7/8/10 task bar.
	EnableTearOffMenus	Enables using of tear-off menus in application.
	EnableUserTools	Enables user-defined plug-ins (user tools) in the application.
	GetBinary	Retrieves the binary data for a specified value field.
	GetContextMenuManager	Gives the access to the global CBCGPContextMenuManager object.
	GetDataVersionMajor	Returns the major version of the workspace state saved in the Windows registry.
	GetDataVersionMinor	Returns the minor version of the workspace state saved in the Windows registry.
	GetDouble	Retrieves the double data for a specified value field.
	GetInt	Retrieves the numeric data for a specified value field.
	GetKeyboardManager	Gives the access to the global CBCGPKeyboardManager object
	GetMouseManager	Gives the access to the global CBCGPMouseManager object.
	GetObject	Retrieves the CObject - derived object data for a specified value field.
	GetRegistryBase	Gets a path to the registry key, which serves as a root for all subsequent registry calls.
	GetRegSectionPath	Concatenates the relative path to a registry key with the application path.
	GetSectionBinary	Retrieves the binary data for a specified value field of a specified key.
	GetSectionDouble	Retrieves the numeric data for a specified value field of a specified key.
	GetSectionInt	Retrieves the numeric data for a specified value field of a specified key.
	GetSectionObject	Retrieves the CObject - derived object data for a specified value field of a specified key.
	GetSectionString	Retrieves the string data for a specified value field of a specified key.
	GetShellManager	Gives the access to the global CBCGPShellManager object.
	GetString	Retrieves the string data for a specified value field.
	GetTooltipManager	Returns a pointer to the tooltip manager.
	GetUserToolsManager	Gives the access to the global CBCGPUserToolsManager object.
	InitContextMenuManager	Initializes the context menu manager.
	InitKeyboardManager	Initializes the keyboard manager.
	InitMouseManager	Initializes the mouse manager.
	InitShellManager	Initializes the shell manager
	InitTooltipManager	Initializes the tooltip manager.
	IsStateExists	Determines whether the specified state does exist or not.
	IsTaskBarInteractionEnabled	Tells whether interaction with Windows 7/8/10 task bar is enabled or disabled.
	LoadState	Loads the application state from the Windows registry.
	LoadState	Loads the application state from the Windows registry.
	LoadState	Loads the application state from the Windows registry.
	LoadState	Loads the application state from the Windows registry.
	OnAppContextHelp	Called by the framework in customization mode to invoke context help.
	OnEditCtrlContextMenu	Called by the framework when edit control's context menu should be displayed.
	OnViewDoubleClick	Invokes a user-defined command that has been associated with a double-click the left mouse button.
	SaveState	Stores the framework's state into the Windows registry.
	SaveState	Stores the framework's state into the Windows registry.
	SaveState	Stores the framework's state into the Windows registry.
	SaveState	Stores the framework's state into the Windows registry.
	SetRegistryBase	Sets a path to the registry key that will serve as a root for all subsequent registry calls.
	ShowPopupMenu	Displays a popup menu.
	WriteBinary	Stores binary data in a specified value field.
	WriteDouble	Stores double data in a specified value field.
	WriteInt	Stores numeric data in a specified value field.
	WriteObject	Stores CObject - derived object data in a specified value field.
	WriteSectionBinary	Stores binary data in a specified value field of a specified key.
	WriteSectionDouble	Stores numeric data in a specified value field of a specified key.
	WriteSectionInt	Stores numeric data in a specified value field of a specified key.
	WriteSectionObject	Stores CObject - derived object data in a specified value field of a specified key.
	WriteSectionString	Stores string data in a specified value field of a specified key.
	WriteString	Stores string data in a specified value field.

Static Public Member Functions
	UseWorkspaceManager	Enables workspace manager for an application.

Public Attributes
	m_bIsAeroSnapPlacement	If this memebr is TRUE, the fraework saves the recent frame position and size in "AeroSnap" mode.
	m_nFileNewFrameCommandID	Specifies the command ID associated with new frame creation (in the multiple top-level document interface applications, usually ID_FILE_NEW_FRAME).

Protected Member Functions
	LoadCustomState	Called by the framework when the BCGControlBar Library-related application state has been loaded.
	LoadWindowPlacement	Called by the framework before a creation of the window attached to a CWnd object to load the window placement information from the registry.
	OnClosingMainFrame	Called by the framework when a main frame window is processing WM_CLOSE message.
	PreLoadState	Called by the framework before the application state is loaded.
	PreSaveState	Called by the framework before the application state is saved.
	ReloadWindowPlacement	Reloads window size and position from the registry
	SaveCustomState	Called by the framework after everything is stored into the Windows registry.
	StoreWindowPlacement	Called by the framework to save the window placement information to registry when the window frame is being closed.

Protected Attributes
	m_bAutoSyncControlBarsStateBetweenFrames	Specifies whether the frame state should be automatically synchronized (in the multiple top-level document interface applications).
	m_bForceImageReset	Force image reset every time when the frame is loaded