KateSession Class Reference

#include <katesession.h>

Inheritance diagram for KateSession:

[legend]

List of all members.

Public Types
typedef KSharedPtr< KateSession >	Ptr
Public Member Functions
KConfig *	configRead ()
KConfig *	configWrite ()
bool	create (const QString &name, bool force=false)
unsigned int	documents () const
void	init ()
bool	isNew () const
	KateSession (KateSessionManager *manager, const QString &fileName, const QString &name)
bool	rename (const QString &name)
QString	sessionFile () const
const QString &	sessionFileRelative () const
const QString &	sessionName () const
	~KateSession ()

---

Detailed Description

Definition at line 40 of file katesession.h.

---

Member Typedef Documentation

typedef KSharedPtr<KateSession> KateSession::Ptr

Define a Shared-Pointer type.

Definition at line 46 of file katesession.h.

---

Constructor & Destructor Documentation

KateSession::KateSession	(	KateSessionManager *	manager,
		const QString &	fileName,
		const QString &	name
	)

create a session from given file

Parameters:

	fileName	session filename, relative
	name	session name
	manager	pointer to the manager

Definition at line 56 of file katesession.cpp.

KateSession::~KateSession

(

)

destruct me

Definition at line 116 of file katesession.cpp.

---

Member Function Documentation

KConfig * KateSession::configRead

(

)

config to read on first access, will create the config object, delete will be done automagic return 0 if we have no file to read config from atm

Returns:

config to read from

Definition at line 180 of file katesession.cpp.

KConfig * KateSession::configWrite

(

)

config to write on first access, will create the config object, delete will be done automagic return 0 if we have no file to write config to atm

Returns:

config to write from

Definition at line 191 of file katesession.cpp.

bool KateSession::create	(	const QString &	name,
		bool	force = false
	)

create the session file, if not existing

Parameters:

	name	name for this session
	force	force to create new file

Returns:

true if created, false if no creation needed

Definition at line 127 of file katesession.cpp.

unsigned int KateSession::documents

(

)

const [inline]

count of documents in this session

Returns:

documents count

Definition at line 126 of file katesession.h.

void KateSession::init

(

)

init the session object, after construction or create

Definition at line 67 of file katesession.cpp.

bool KateSession::isNew

(

)

const [inline]

is this a valid session? if not, don't use any session if this is the active one

Definition at line 89 of file katesession.h.

bool KateSession::rename

(

const QString &

name

)

rename this session

Parameters:

name

new name

Returns:

success

Definition at line 165 of file katesession.cpp.

QString KateSession::sessionFile

(

)

const

session filename, absolute, calculated out of relative filename + session dir

Returns:

absolute path to session file

Definition at line 122 of file katesession.cpp.

const QString& KateSession::sessionFileRelative

(

)

const [inline]

relative session filename

Returns:

relative filename for this session

Definition at line 77 of file katesession.h.

const QString& KateSession::sessionName

(

)

const [inline]

session name

Returns:

name for this session

Definition at line 83 of file katesession.h.

---

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

• katesession.h
• katesession.cpp