#include <ISession.h>
ISession is the main interface off the root object in the hierarchy (instance of kSessionBoss). It contains global state information. The session is handed to every plug-in in its IPlugIn::Load function. Each execution context (thread) has only one session object which is accessible via GetExecutionContextSession()or by calling GetSession() on IExecutionContext.
Supplies plugins with references to key objects, such as:
- See Also
- kSessionBoss
- kActiveContextBoss
- IActiveContext
- kWorkspaceBoss
- IWorkspace
- kAppBoss
- IApplication
- kCommandProcessorBoss
- ICommandProcessor
The state of the session: starting up, running, shutting down.
The state of the session: starting up, running, shutting down.
Return the active context object. You shouldn't need to call this function, since the active context is now passed into every method that needs it. But there may be some edge cases we missed, so if you need the active document, active tool, active window, etc., and find no other way to get it, this is left available.
- Returns
- IActiveContext* the global active context
Return the global change manager used in broadcasting messages. Normally you do not need to call this; it is called for you by CSubject.
- Returns
- IChangeManager* the global change manager
Return an instance of a global event converter to convert system events to IEvents. You should not need to call this directly.
- Returns
- IEventConverter* the global event converter
Return the current state of the session.
- Returns
- SessionStateType session status
Return a reference to the global application. The application object is a singleton that contains the list of open documents, windows, panels, tools, etc. Also version number and name info for the application. Returns nil if the application is in the process of shutting down.
- Returns
- IApplication* the global application
| virtual IAutomationManager* ISession::QueryAutomationMangager | ( | | ) | |
| pure virtual |
Return a reference to the global automation manager
- Returns
- IAutomationManager* the global automation manager boss
Return a reference to the global command processor. Normally this is called for you by CmdUtils.
- Returns
- ICommandProcessor* the global command processor
Returns a reference to the list of open documents.
Return a reference to the global INX manager
- Returns
- IINXManager* the global INX manager boss
| virtual IUserActionPersonalityManager* ISession::QueryUserActionPersonalityMangager | ( | | ) | |
| pure virtual |
Return a reference to the global user action personality manager
- Returns
- IUserActionPersonalityManager* the global user action personality manager boss
Return a reference to the global workspace. The workspace contains application preference data. Returns nil if called very early in startup, or late in shutdown. For instance, plug-in load functions, or early initializers will return nil. Left here for compatibility with previous releases.
- Returns
- IWorkspace* the global workspace
Return a reference to the global workspace, with a particular interface requested. The workspace contains application preference data. Returns nil if called very early in startup, or late in shutdown. For instance, plug-in load functions, or early initializers will return nil.
- Parameters
| faceID | which interface to return |
- Returns
- IWorkspace* the global workspace
Public Member Functions inherited from IPMUnknown
1.8.3.1 
