• Skip to content
  • Skip to link menu
KDE 4.2 API Reference
  • KDE API Reference
  • API Reference
  • Sitemap
  • Contact Us
 

Konsole

Konsole::SessionGroup

Konsole::SessionGroup Class Reference

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

#include <Session.h>

Inheritance diagram for Konsole::SessionGroup:

Inheritance graph
[legend]

List of all members.


Public Types

enum  MasterMode { CopyInputToAll = 1 }

Public Member Functions

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

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


Constructor & Destructor Documentation

SessionGroup::SessionGroup ( QObject *  parent  ) 

Constructs an empty session group.

Definition at line 1162 of file Session.cpp.

SessionGroup::~SessionGroup (  ) 

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

Definition at line 1166 of file Session.cpp.


Member Function Documentation

void SessionGroup::addSession ( Session *  session  ) 

Adds a session to the group.

Definition at line 1175 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 1171 of file Session.cpp.

bool SessionGroup::masterStatus ( Session *  session  )  const

Returns the master status of a session.

See setMasterStatus()

Definition at line 1173 of file Session.cpp.

void SessionGroup::removeSession ( Session *  session  ) 

Removes a session from the group.

Definition at line 1186 of file Session.cpp.

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

Returns the list of sessions currently in the group.

Definition at line 1172 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 1205 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 1239 of file Session.cpp.


The documentation for this class was generated from the following files:
  • Session.h
  • Session.cpp

Konsole

Skip menu "Konsole"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

API Reference

Skip menu "API Reference"
  • Konsole
  • Libraries
  •   libkonq
Generated for API Reference by doxygen 1.5.7
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal