KDSingleApplication API Documentation 1.1
Loading...
Searching...
No Matches
Public Types | Public Slots | Signals | Public Member Functions | Properties | List of all members
KDSingleApplication Class Reference

#include <kdsingleapplication.h>

Inheritance diagram for KDSingleApplication:
Inheritance graph
[legend]
Collaboration diagram for KDSingleApplication:
Collaboration graph
[legend]

Public Types

enum class  Option { None = 0x0 , IncludeUsernameInSocketName = 0x1 , IncludeSessionInSocketName = 0x2 }
 

Public Slots

bool sendMessage (const QByteArray &message)
 
bool sendMessageWithTimeout (const QByteArray &message, int timeout)
 

Signals

void messageReceived (const QByteArray &message)
 

Public Member Functions

 KDSingleApplication (const QString &name, Options options, QObject *parent=nullptr)
 
 KDSingleApplication (const QString &name, QObject *parent=nullptr)
 
 KDSingleApplication (QObject *parent=nullptr)
 
 ~KDSingleApplication ()
 
bool isPrimaryInstance () const
 
QString name () const
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
virtual ~QObject ()
 
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 ()
 
void dumpObjectInfo () const const
 
void dumpObjectTree ()
 
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 QRegExp &regExp, 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
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
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_DISABLE_COPY (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 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
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
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 setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
QThreadthread () const const
 

Properties

bool isPrimaryInstance
 
QString name
 
- Properties inherited from QObject
 objectName
 

Additional Inherited Members

- 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)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Public Attributes inherited from QObject
typedef QObjectList
 
- 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

Definition at line 22 of file kdsingleapplication.h.

Member Enumeration Documentation

◆ Option

enum class KDSingleApplication::Option
strong
Enumerator
None 
IncludeUsernameInSocketName 
IncludeSessionInSocketName 

Definition at line 31 of file kdsingleapplication.h.

Constructor & Destructor Documentation

◆ KDSingleApplication() [1/3]

KDSingleApplication::KDSingleApplication ( QObject parent = nullptr)
explicit

Definition at line 69 of file kdsingleapplication.cpp.

◆ KDSingleApplication() [2/3]

KDSingleApplication::KDSingleApplication ( const QString name,
QObject parent = nullptr 
)
explicit

Definition at line 74 of file kdsingleapplication.cpp.

◆ KDSingleApplication() [3/3]

KDSingleApplication::KDSingleApplication ( const QString name,
Options  options,
QObject parent = nullptr 
)
explicit

Definition at line 80 of file kdsingleapplication.cpp.

◆ ~KDSingleApplication()

KDSingleApplication::~KDSingleApplication ( )
default

Member Function Documentation

◆ isPrimaryInstance()

bool KDSingleApplication::isPrimaryInstance ( ) const

Definition at line 92 of file kdsingleapplication.cpp.

◆ messageReceived

void KDSingleApplication::messageReceived ( const QByteArray message)
signal

◆ name()

QString KDSingleApplication::name ( ) const

Definition at line 86 of file kdsingleapplication.cpp.

◆ sendMessage

bool KDSingleApplication::sendMessage ( const QByteArray message)
slot

Definition at line 98 of file kdsingleapplication.cpp.

References sendMessageWithTimeout().

◆ sendMessageWithTimeout

bool KDSingleApplication::sendMessageWithTimeout ( const QByteArray message,
int  timeout 
)
slot

Definition at line 103 of file kdsingleapplication.cpp.

References isPrimaryInstance.

Referenced by sendMessage().

Property Documentation

◆ isPrimaryInstance

bool KDSingleApplication::isPrimaryInstance
read

Definition at line 26 of file kdsingleapplication.h.

Referenced by sendMessageWithTimeout().

◆ name

QString KDSingleApplication::name
read

Definition at line 25 of file kdsingleapplication.h.


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

© Klarälvdalens Datakonsult AB (KDAB)
"The Qt, C++ and OpenGL Experts"
https://www.kdab.com/
KDSingleApplication
A helper class for single-instance policy Qt applications
Generated on Sat Apr 13 2024 00:10:51 for KDSingleApplication API Documentation by doxygen 1.9.8