Konsole::SessionGroup Class Reference

#include <Session.h>

Inheritance diagram for Konsole::SessionGroup:

Public Types
enum	MasterMode { CopyInputToAll = 1 }

Public Member Functions
	SessionGroup (QObject *parent)
	~SessionGroup ()
void	addSession (Session *session)
int	masterMode () const
bool	masterStatus (Session *session) const
void	removeSession (Session *session)
QList< Session * >	sessions () const
void	setMasterMode (int mode)
void	setMasterStatus (Session *session, bool master)

Detailed Description

Provides a group of sessions which is divided into master and slave sessions.

Activity in master sessions can be propagated to all sessions within the group. The type of activity which is propagated and method of propagation is controlled by the masterMode() flags.

Definition at line 759 of file Session.h.

Member Enumeration Documentation

enum Konsole::SessionGroup::MasterMode

This enum describes the options for propagating certain activity or changes in the group's master sessions to all sessions in the group.

Enumerator
CopyInputToAll	Any input key presses in the master sessions are sent to all sessions in the group.

Definition at line 793 of file Session.h.

Constructor & Destructor Documentation

SessionGroup::SessionGroup ( QObject *  parent )

explicit

Constructs an empty session group.

Definition at line 1443 of file Session.cpp.

SessionGroup::~SessionGroup

(

)

Destroys the session group and removes all connections between master and slave sessions.

Definition at line 1447 of file Session.cpp.

Member Function Documentation

void SessionGroup::addSession

(

Session *

session

)

Adds a session to the group.

Definition at line 1463 of file Session.cpp.

int SessionGroup::masterMode

(

)

const

Returns a bitwise OR of the active MasterMode flags for this group.

See setMasterMode()

Definition at line 1450 of file Session.cpp.

bool SessionGroup::masterStatus

(

Session *

session

)

const

Returns the master status of a session.

See setMasterStatus()

Definition at line 1458 of file Session.cpp.

void SessionGroup::removeSession

(

Session *

session

)

Removes a session from the group.

Definition at line 1468 of file Session.cpp.

QList< Session * > SessionGroup::sessions

(

)

const

Returns the list of sessions currently in the group.

Definition at line 1454 of file Session.cpp.

void SessionGroup::setMasterMode

(

int

mode

)

Specifies which activity in the group's master sessions is propagated to all sessions in the group.

Parameters

mode	A bitwise OR of MasterMode flags.

Definition at line 1480 of file Session.cpp.

void SessionGroup::setMasterStatus	(	Session *	session,
		bool	master
	)

Sets whether a particular session is a master within the group.

Changes or activity in the group's master sessions may be propagated to all the sessions in the group, depending on the current masterMode()

Parameters

session	The session whose master status should be changed.
master	True to make this session a master or false otherwise

Definition at line 1488 of file Session.cpp.

---

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

• Session.h
• Session.cpp