Konsole::SessionGroup

Search for usage in LXR

Konsole::SessionGroup Class Reference

#include <Session.h>

Inheritance diagram for Konsole::SessionGroup:

Public Types

enum  MasterMode { CopyInputToAll = 1 }
 
- Public Types inherited from QObject
typedef  QObjectList
 

Public Member Functions

 SessionGroup ()
 
 ~SessionGroup () override
 
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)
 
QBindable< QStringbindableObjectName ()
 
bool blockSignals (bool block)
 
const QObjectListchildren () const const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectInfo () const const
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isQuickItemType () const const
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_GADGET_EXPORT (EXPORT_MACRO)
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_MOC_INCLUDE Q_MOC_INCLUDE
 
 Q_NAMESPACE Q_NAMESPACE
 
 Q_NAMESPACE_EXPORT (EXPORT_MACRO)
 
 Q_OBJECT Q_OBJECT
 
 Q_PROPERTY (...)
 
 Q_REVISION Q_REVISION
 
 Q_SET_OBJECT_NAME (Object)
 
 Q_SIGNAL Q_SIGNAL
 
 Q_SIGNALS Q_SIGNALS
 
 Q_SLOT Q_SLOT
 
 Q_SLOTS Q_SLOTS
 
qobject_cast (const QObject *object)
 
qobject_cast (QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setObjectName (QAnyStringView name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool setProperty (const char *name, QVariant &&value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)
 
QThreadthread () const const
 

Additional Inherited Members

- Properties inherited from QObject
 objectName
 
- Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
bool disconnect (const QMetaObject::Connection &connection)
 
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)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
bool isSignalConnected (const QMetaMethod &signal) const const
 
int receivers (const char *signal) const const
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

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

Member Enumeration Documentation

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

Constructor & Destructor Documentation

◆ SessionGroup()

SessionGroup::SessionGroup ( )

Constructs an empty session group.

Definition at line 802 of file Session.cpp.

◆ ~SessionGroup()

SessionGroup::~SessionGroup ( )
override

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

Definition at line 806 of file Session.cpp.

Member Function Documentation

◆ addSession()

void SessionGroup::addSession ( Session * session)

Adds a session to the group.

Definition at line 824 of file Session.cpp.

◆ masterMode()

int SessionGroup::masterMode ( ) const

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

See setMasterMode()

Definition at line 811 of file Session.cpp.

◆ masterStatus()

bool SessionGroup::masterStatus ( Session * session) const

Returns the master status of a session.

See setMasterStatus()

Definition at line 819 of file Session.cpp.

◆ removeSession()

void SessionGroup::removeSession ( Session * session)

Removes a session from the group.

Definition at line 834 of file Session.cpp.

◆ sessions()

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

Returns the list of sessions currently in the group.

Definition at line 815 of file Session.cpp.

◆ setMasterMode()

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 846 of file Session.cpp.

◆ setMasterStatus()

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 whoose master status should be changed.
masterTrue to make this session a master or false otherwise

Definition at line 877 of file Session.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Dec 6 2024 12:04:23 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.