SUIT_Session Class Reference

#include <SUIT_Session.h>

Inheritance diagram for SUIT_Session:

Public Types
enum	{ ASK = 0 , SAVE , DONT_SAVE }
enum	{ NORMAL = 0 , FORCED }
typedef void *	AppLib

Signals
void	applicationClosed (SUIT_Application *)

Public Member Functions
	SUIT_Session ()
virtual	~SUIT_Session ()
SUIT_Application *	startApplication (const QString &, int=0, char **=0)
QList< SUIT_Application * >	applications () const
SUIT_Application *	activeApplication () const
SUIT_ResourceMgr *	resourceMgr () const
void	closeSession (int mode=ASK, int flags=0)
int	exitFlags () const
SUIT_ExceptionHandler *	handler () const
void	insertApplication (SUIT_Application *)

Static Public Member Functions
static SUIT_Session *	session ()

Public Attributes
enum SUIT_Session:: { ... }	CloseMode
enum SUIT_Session:: { ... }	ExitStatus

Protected Member Functions
virtual SUIT_ResourceMgr *	createResourceMgr (const QString &) const

Private Types
typedef QList< SUIT_Application * >	AppList
typedef QMap< QString, AppLib >	AppLibMap

Private Slots
void	onApplicationClosed (SUIT_Application *)
void	onApplicationActivated (SUIT_Application *)

Private Member Functions
QString	lastError () const
AppLib	loadLibrary (const QString &, QString &)
QString	applicationName (const QString &) const

Private Attributes
SUIT_ResourceMgr *	myResMgr
AppList	myAppList
AppLibMap	myAppLibs
SUIT_Application *	myActiveApp
SUIT_ExceptionHandler *	myHandler
int	myExitStatus
int	myExitFlags

Static Private Attributes
static SUIT_Session *	mySession = 0

Detailed Description

The class Sesssion manages launching of Applications. Application must be returned
by static function "createApplication" in external library. The Library must be loaded with
loadLibrary method and after that application can be started.

Member Typedef Documentation

AppLib

typedef void* SUIT_Session::AppLib

AppLibMap

typedef QMap<QString, AppLib> SUIT_Session::AppLibMap

private

AppList

typedef QList<SUIT_Application*> SUIT_Session::AppList

private

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
ASK
SAVE
DONT_SAVE

anonymous enum

anonymous enum

Enumerator
NORMAL
FORCED

Constructor & Destructor Documentation

SUIT_Session()

SUIT_Session::SUIT_Session

(

)

Constructor.

References mySession, and SUIT_ASSERT.

~SUIT_Session()

SUIT_Session::~SUIT_Session ( )

virtual

destructor. Clear applications list and set mySession to zero.

References myAppList, myResMgr, and mySession.

Member Function Documentation

activeApplication()

SUIT_Application * SUIT_Session::activeApplication

(

)

const

Returns the active application

References myActiveApp.

applicationClosed

void SUIT_Session::applicationClosed ( SUIT_Application *  )

signal

applicationName()

QString SUIT_Session::applicationName ( const QString &  str ) const

private

Return values

Return

file name by application name.

References Qtx::file().

applications()

QList< SUIT_Application * > SUIT_Session::applications

(

)

const

Gets the list of all applications

References myAppList.

closeSession()

void SUIT_Session::closeSession	(	int	mode = ASK,
		int	flags = 0
	)

Destroys session by closing all applications.

References SUIT_Application::activeStudy(), ASK, SUIT_Application::closeApplication(), DONT_SAVE, FORCED, SUIT_Study::isModified(), SUIT_Application::isPossibleToClose(), SUIT_Study::isSaved(), myAppList, myExitFlags, myExitStatus, SAVE, and SUIT_Study::saveDocument().

createResourceMgr()

SUIT_ResourceMgr * SUIT_Session::createResourceMgr ( const QString &  appName ) const

protectedvirtual

Virtual method, creates an instance of ResourceManager

References applicationName().

exitFlags()

int SUIT_Session::exitFlags

(

)

const

Get session exit flags.

By default, exit flags are set to 0. You can use pass any flags to the closeSession() method if you need to process them later on application quiting.

Returns

exit flags

References myExitFlags.

handler()

SUIT_ExceptionHandler * SUIT_Session::handler

(

)

const

Return values

return

myHandler

References myHandler.

insertApplication()

void SUIT_Session::insertApplication

(

SUIT_Application *

app

)

References applicationClosed(), myAppList, onApplicationActivated(), and onApplicationClosed().

lastError()

QString SUIT_Session::lastError ( ) const

private

Return values

return

last error string.

References Qtx::toQString().

loadLibrary()

SUIT_Session::AppLib SUIT_Session::loadLibrary ( const QString &  name, QString &  libName  )

private

Load library to session.

Return values

Loaded

library.

References Qtx::library().

onApplicationActivated

void SUIT_Session::onApplicationActivated ( SUIT_Application *  app )

privateslot

Slot, called on activation of some application's desktop

References myActiveApp.

onApplicationClosed

void SUIT_Session::onApplicationClosed ( SUIT_Application *  theApp )

privateslot

Removes the application from the list of launched applications. If it is a last application the session will be closed.

References applicationClosed(), myActiveApp, myAppList, and myExitStatus.

resourceMgr()

SUIT_ResourceMgr * SUIT_Session::resourceMgr

(

)

const

Returns the resource manager for the specified application name.

References myResMgr.

session()

SUIT_Session * SUIT_Session::session ( )

static

Return values

return

mySession

References mySession.

startApplication()

SUIT_Application * SUIT_Session::startApplication	(	const QString &	name,
		int	= 0,
		char **	= 0
	)

Starts new application using "createApplication" function of loaded DLL.

References APP_CREATE_NAME, APP_GET_HANDLER_NAME, applicationName(), createResourceMgr(), insertApplication(), lastError(), QtxResourceMgr::loadLanguage(), loadLibrary(), myAppLibs, myAppList, myHandler, myResMgr, SUIT_Application::start(), and SUIT_MessageBox::warning().

Member Data Documentation

enum { ... } SUIT_Session::CloseMode

enum { ... } SUIT_Session::ExitStatus

myActiveApp

SUIT_Application* SUIT_Session::myActiveApp

private

myAppLibs

AppLibMap SUIT_Session::myAppLibs

private

myAppList

AppList SUIT_Session::myAppList

private

myExitFlags

int SUIT_Session::myExitFlags

private

myExitStatus

int SUIT_Session::myExitStatus

private

myHandler

SUIT_ExceptionHandler* SUIT_Session::myHandler

private

myResMgr

SUIT_ResourceMgr* SUIT_Session::myResMgr

private

mySession

SUIT_Session * SUIT_Session::mySession = 0

staticprivate

---

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

• src/SUIT/SUIT_Session.h
• src/SUIT/SUIT_Session.cxx