KateSession Class Reference

An object representing a Kate's session. More...

#include <katesession.h>

List of all members.

Public Member Functions
	KateSession (const KateSessionManager &manager, const TQString &sessionName, const TQString &fileName)
	KateSession (const KateSession &session, const TQString &newSessionName)
	~KateSession ()
const TQString &	getSessionName () const
void	setSessionName (const TQString &sessionName)
bool	isReadOnly () const
void	setReadOnly (bool readOnly)
const TQString &	getSessionFilename () const
bool	isStillVolatile () const
int	getDocCount () const
void	load (bool includeGUIInfo)
void	save (bool saveGUIInfo, bool setReadOnly=false)
void	activate ()
Friends
class	KateViewSpace

---

Detailed Description

An object representing a Kate's session.

Definition at line 47 of file katesession.h.

---

Constructor & Destructor Documentation

KateSession::KateSession	(	const KateSessionManager &	manager,
		const TQString &	sessionName,
		const TQString &	fileName
	)

create a new session and read the config from fileName if it exists

Parameters:

	manager	the session manager handling this session
	sessionName	session name
	fileName	file where session config is saved to/restored from

Definition at line 88 of file katesession.cpp.

KateSession::KateSession	(	const KateSession &	session,
		const TQString &	newSessionName
	)

duplicate an existing session into a new one with the given new name.

If the existing session is read-only, the new one will *not* be read-only by default

Parameters:

	session	the existing session
	newSessionName	the name of the new session

Definition at line 97 of file katesession.cpp.

KateSession::~KateSession

(

)

Destructor.

Definition at line 111 of file katesession.cpp.

---

Member Function Documentation

void KateSession::activate

(

)

Activate the session.

Definition at line 255 of file katesession.cpp.

int KateSession::getDocCount

(

)

const [inline]

Returns:

the number of documents in the session

Definition at line 108 of file katesession.h.

const TQString& KateSession::getSessionFilename

(

)

const [inline]

Returns:

the session filename if available, otherwise the null string

Definition at line 97 of file katesession.h.

const TQString& KateSession::getSessionName

(

)

const [inline]

Returns:

the session name

Definition at line 75 of file katesession.h.

bool KateSession::isReadOnly

(

)

const [inline]

Returns:

whether the session is read only or not

Definition at line 86 of file katesession.h.

bool KateSession::isStillVolatile

(

)

const

Returns:

whether the session is still volatile, i.e. it has never been saved and never been named

Definition at line 126 of file katesession.cpp.

void KateSession::load

(

bool

includeGUIInfo

)

Load session info from the saved file.

Parameters:

includeGUIInfo

if true, also load the information about the GUI elements

Definition at line 132 of file katesession.cpp.

void KateSession::save	(	bool	saveGUIInfo,
		bool	setReadOnly = false
	)

Save session info.

Parameters:

	saveGUIInfo	if true, save also the information about the GUI elements
	setReadOnly	necessary to save a session that has to be turned to read only

Definition at line 198 of file katesession.cpp.

void KateSession::setReadOnly

(

bool

readOnly

)

[inline]

Set session read only status.

Parameters:

readOnly

if true, the session status can not be modified

Definition at line 92 of file katesession.h.

void KateSession::setSessionName

(

const TQString &

sessionName

)

Set the new session name.

Parameters:

sessionName

the new session name

Definition at line 120 of file katesession.cpp.

---

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

• katesession.h
• katesession.cpp