• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • applications API Reference
  • KDE Home
  • Contact Us
 

Konsole

  • Konsole
  • SessionGroup
Public Types | Public Member Functions | List of all members
Konsole::SessionGroup Class Reference

#include <Session.h>

Inheritance diagram for Konsole::SessionGroup:
Inheritance graph
[legend]

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)
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
 QObject (QObject *parent, const char *name)
 
virtual  ~QObject ()
 
bool blockSignals (bool block)
 
QObject * child (const char *objName, const char *inheritsClass, bool recursiveSearch) const
 
const QObjectList & children () const
 
const char * className () const
 
bool connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const QObject *receiver, const char *method)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method)
 
void dumpObjectInfo ()
 
void dumpObjectTree ()
 
QList< QByteArray > dynamicPropertyNames () const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
T findChild (const QString &name) const
 
QList< T > findChildren (const QRegExp &regExp) const
 
QList< T > findChildren (const QString &name) const
 
bool inherits (const char *className) const
 
void insertChild (QObject *object)
 
void installEventFilter (QObject *filterObj)
 
bool isA (const char *className) const
 
bool isWidgetType () const
 
void killTimer (int id)
 
virtual const QMetaObject * metaObject () const
 
void moveToThread (QThread *targetThread)
 
const char * name () const
 
const char * name (const char *defaultName) const
 
QString objectName () const
 
QObject * parent () const
 
QVariant property (const char *name) const
 
void removeChild (QObject *object)
 
void removeEventFilter (QObject *obj)
 
void setName (const char *name)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const
 
int startTimer (int interval)
 
QThread * thread () const
 

Additional Inherited Members

- Static Public Member Functions inherited from QObject
bool connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
bool connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Protected Member Functions inherited from QObject
bool checkConnectArgs (const char *signal, const QObject *object, const char *method)
 
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const char *signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const char *signal)
 
int receivers (const char *signal) const
 
QObject * sender () const
 
int senderSignalIndex () const
 
virtual void timerEvent (QTimerEvent *event)
 
- Static Protected Member Functions inherited from QObject
QByteArray normalizeSignalSlot (const char *signalSlot)
 
- Properties inherited from QObject
 objectName
 

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

Constructor & Destructor Documentation

SessionGroup::SessionGroup ( QObject *  parent)
explicit

Constructs an empty session group.

Definition at line 1450 of file Session.cpp.

SessionGroup::~SessionGroup ( )

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

Definition at line 1454 of file Session.cpp.

Member Function Documentation

void SessionGroup::addSession ( Session *  session)

Adds a session to the group.

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

bool SessionGroup::masterStatus ( Session *  session) const

Returns the master status of a session.

See setMasterStatus()

Definition at line 1465 of file Session.cpp.

void SessionGroup::removeSession ( Session *  session)

Removes a session from the group.

Definition at line 1475 of file Session.cpp.

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

Returns the list of sessions currently in the group.

Definition at line 1461 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
modeA bitwise OR of MasterMode flags.

Definition at line 1487 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
sessionThe session whose master status should be changed.
masterTrue to make this session a master or false otherwise

Definition at line 1495 of file Session.cpp.


The documentation for this class was generated from the following files:
  • Session.h
  • Session.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Sat May 9 2020 03:56:28 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

Konsole

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

applications API Reference

Skip menu "applications API Reference"
  •   kate
  •       kate
  •   KTextEditor
  •   Kate
  • Konsole

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal