KontactInterface::PimUniqueApplication Class

class KontactInterface::PimUniqueApplication
Header: #include <KontactInterface/PimUniqueApplication>
CMake: find_package(KPim6KontactInterface REQUIRED)
target_link_libraries(mytarget PRIVATE KPim6::KontactInterface)

Public Functions

PimUniqueApplication(int &argc, char **[] argv)
QCommandLineParser *cmdArgs() const
void setAboutData(KAboutData &aboutData)

Public Slots

int newInstance()
virtual int newInstance(const QByteArray &startupId, const QStringList &arguments, const QString &workingDirectory)

Static Public Members

bool start(const QStringList &arguments)

Detailed Description

KDEPIM applications which can be integrated into kontact should use PimUniqueApplication instead of QApplication + Dbus unique. This makes command-line handling work, i.e. you can launch "korganizer" and if kontact is already running, it will load the korganizer part and switch to it.

Member Function Documentation

[explicit] PimUniqueApplication::PimUniqueApplication(int &argc, char **[] argv)

Creates a new application with the command line arguments argc and argv.

QCommandLineParser *PimUniqueApplication::cmdArgs() const

[slot] int PimUniqueApplication::newInstance()

Note: This slot is overloaded. To connect to this slot:

// Connect using qOverload:
connect(sender, &SenderClass::signal,
        pimUniqueApplication, qOverload<>(&PimUniqueApplication::newInstance));

// Or using a lambda as wrapper:
connect(sender, &SenderClass::signal,
        pimUniqueApplication, [receiver = pimUniqueApplication]() { receiver->newInstance(); });
For more examples and approaches, see connecting to overloaded slots.

[virtual slot] int PimUniqueApplication::newInstance(const QByteArray &startupId, const QStringList &arguments, const QString &workingDirectory)

Note: This slot is overloaded. To connect to this slot:

// Connect using qOverload:
connect(sender, &SenderClass::signal,
        pimUniqueApplication, qOverload(&PimUniqueApplication::newInstance));

// Or using a lambda as wrapper:
connect(sender, &SenderClass::signal,
        pimUniqueApplication, [receiver = pimUniqueApplication](const QByteArray &startupId, const QStringList &arguments, const QString &workingDirectory) { receiver->newInstance(startupId, arguments, workingDirectory); });
For more examples and approaches, see connecting to overloaded slots.

void PimUniqueApplication::setAboutData(KAboutData &aboutData)

Sets the aboutData of the application.

[static] bool PimUniqueApplication::start(const QStringList &arguments)

Register this process as a unique application, if not already running. Typically called in main(). arguments should start with the appname, as QCoreApplication::arguments() does.

Returns true if this process was registered as the unique application, false if the arguments were forwarded to an already running instance (main() can then exit).