Konsole

Konsole::SessionGroup

Konsole::SessionGroup Class Reference

#include <Session.h>

Inheritance diagram for Konsole::SessionGroup:

[legend]

List of all members.

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 552 of file Session.h.


Public Types
enum	MasterMode { CopyInputToAll = 1 }
Public Member Functions
	SessionGroup ()
	~SessionGroup ()
void	addSession (Session *session)
void	removeSession (Session *session)
QList< Session * >	sessions () const
void	setMasterStatus (Session *session, bool master)
bool	masterStatus (Session *session) const
void	setMasterMode (int mode)
int	masterMode () const

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 586 of file Session.h.

Constructor & Destructor Documentation

SessionGroup::SessionGroup ( )

Constructs an empty session group.

Definition at line 915 of file Session.cpp.

SessionGroup::~SessionGroup ( )

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

Definition at line 919 of file Session.cpp.

Member Function Documentation

void SessionGroup::addSession ( Session * session )

Adds a session to the group.

Definition at line 928 of file Session.cpp.

void SessionGroup::removeSession ( Session * session )

Removes a session from the group.

Definition at line 937 of file Session.cpp.

QList< Session * > SessionGroup::sessions ( ) const

Returns the list of sessions currently in the group.

Definition at line 925 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 whoose master status should be changed.
	master	True to make this session a master or false otherwise

Definition at line 982 of file Session.cpp.

bool SessionGroup::masterStatus ( Session * session ) const

Returns the master status of a session.

See setMasterStatus()

Definition at line 926 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 948 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 924 of file Session.cpp.

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

Konsole

Konsole::SessionGroup Class Reference

Detailed Description

Public Types

Public Member Functions

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Konsole

API Reference