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

KDEUI

KUniqueApplication Class Reference

#include <kuniqueapplication.h>

Inheritance diagram for KUniqueApplication:

Inheritance graph
[legend]

List of all members.


Detailed Description

KUniqueApplication is a KApplication which only uses a single process.

When a KUniqueApplication is started, it attempts to contact an existing copy of the application. If successful, the program asks the existing process to create a new instance by calling its newInstance() method and then exits. If there is no existing process then the program forks and calls the newInstance() method. When newInstance() is called, the application will typically create a new window or activate an existing one.

Instances of KUniqueApplication can be made to behave like a normal application by passing the StartFlag::NonUniqueInstance flag to start().

Please note that this supports only one process per KDE session. If your application can only be opened once per user or once per host, you need to ensure this independently of KUniqueApplication.

The .desktop file for the application should state X-DBUS-StartupType=Unique, see ktoolinvocation.h

If your application is used to open files, it should also support the --tempfile option (see KCmdLineArgs::addTempFileOption()), to delete tempfiles after use. Add X-KDE-HasTempFileOption=true to the .desktop file to indicate this.

See also:
KApplication
Author:
Preston Brown <pbrown@kde.org>

Definition at line 52 of file kuniqueapplication.h.


Public Types

enum  StartFlag { NonUniqueInstance = 0x1 }

Public Member Functions

 KUniqueApplication (Display *display, Qt::HANDLE visual=0, Qt::HANDLE colormap=0, bool configUnique=false)
 KUniqueApplication (bool GUIenabled=true, bool configUnique=false)
virtual int newInstance ()
bool restoringSession ()
virtual ~KUniqueApplication ()

Static Public Member Functions

static void addCmdLineOptions ()
static void setHandleAutoStarted ()
static bool start ()
static bool start (StartFlags flags)

Member Enumeration Documentation

enum KUniqueApplication::StartFlag

These flags can be used to specify how new instances of unique applications are created.

Enumerator:
NonUniqueInstance  Create a new instance of the application in a new process and do not attempt to re-use an existing process.

With this flag set, the new instance of the application will behave as if it were a plain KApplication rather than a KUniqueApplication.

This is useful if you have an application where all instances are typically run in a single process but under certain circumstances new instances may require their own process.

Definition at line 103 of file kuniqueapplication.h.


Constructor & Destructor Documentation

KUniqueApplication::KUniqueApplication ( bool  GUIenabled = true,
bool  configUnique = false 
) [explicit]

Constructor.

Takes command line arguments from KCmdLineArgs

Parameters:
GUIenabled Set to false to disable all GUI stuff. This implies no styles either.
configUnique If true, the uniqueness of the application will depend on the value of the "MultipleInstances" key in the "KDE" group of the application config file.

Definition at line 324 of file kuniqueapplication.cpp.

KUniqueApplication::KUniqueApplication ( Display *  display,
Qt::HANDLE  visual = 0,
Qt::HANDLE  colormap = 0,
bool  configUnique = false 
) [explicit]

Constructor.

Takes command line arguments from KCmdLineArgs

Parameters:
display Will be passed to Qt as the X display. The display must be valid and already opened.
visual Pointer to the X11 visual that should be used by the application. If NULL, the default visual will be used instead.
colormap The colormap that should be used by the application. If 0, the default colormap will be used instead.
configUnique If true, the uniqueness of the application will depend on the value of the "MultipleInstances" key in the "KDE" group of the application config file.

Definition at line 341 of file kuniqueapplication.cpp.

KUniqueApplication::~KUniqueApplication (  )  [virtual]

Destructor.

Definition at line 359 of file kuniqueapplication.cpp.


Member Function Documentation

void KUniqueApplication::addCmdLineOptions (  )  [static]

Adds command line options specific for KUniqueApplication.

Should be called before calling KUniqueApplication constructor and / or start().

Definition at line 82 of file kuniqueapplication.cpp.

int KUniqueApplication::newInstance (  )  [virtual]

Creates a new "instance" of the application.

Usually this will involve making some calls into the GUI portion of your application asking for a new window to be created, possibly with some data already loaded based on the arguments received.

Command line arguments have been passed to KCmdLineArgs before this function is called and can be checked in the usual way.

The default implementation ensures the mainwindow of the already running instance is shown and activated if necessary. If your application has only one mainwindow, you should call this default implementation and only add your special handling if needed.

Note that newInstance() is called also in the first started application process.

For applications that share one process for several mainwindows, the reimplementation could be:

    int MyApp::newInstance()
    {
    KCmdLineArgs::setCwd(QDir::currentPath().toUtf8());
    KCmdLineArgs* args = KCmdLineArgs::parsedArgs();
    static bool first = true;
    if (args->count() > 0) {
        for (int i = 0; i < args->count(); ++i) {
            openWindow(args->url(i));
        }
    } else if( !first || !isSessionRestored()) {
        openWindow(KUrl()); // create a new window
    }
    first = false;
    args->clear();
    return 0;
    }

Returns:
An exit value. The calling process will exit with this value.

Definition at line 412 of file kuniqueapplication.cpp.

bool KUniqueApplication::restoringSession (  ) 

Returns whether newInstance() is being called while session restoration is in progress.

Definition at line 407 of file kuniqueapplication.cpp.

void KUniqueApplication::setHandleAutoStarted (  )  [static]

For internal use only.

Definition at line 435 of file kuniqueapplication.cpp.

bool KUniqueApplication::start (  )  [static]

Definition at line 104 of file kuniqueapplication.cpp.

bool KUniqueApplication::start ( StartFlags  flags  )  [static]

Forks and registers with D-Bus.

The command line arguments are being sent via D-Bus to newInstance() and will be received once the application enters the event loop.

Typically this is used like:

 int main(int argc, char **argv) {
    KAboutData about("myappname", 0, ki18n("myAppName"), .....);
    KCmdLineArgs::init(argc, argv, &about);
    KCmdLineArgs::addCmdLineOptions( myCmdOptions );
    KUniqueApplication::addCmdLineOptions();

    if (!KUniqueApplication::start()) {
       fprintf(stderr, "myAppName is already running!\n");
       return 0;
    }
    KUniqueApplication a;
    return a.exec();
 }
Note that it's not necessary to call start() explicitly. It will be called automatically before creating KUniqueApplication if it hasn't been called yet, without any performance impact.

Also note that you MUST call KUniqueApplication::addCmdLineOptions(), if you use command line options before start() is called.

Parameters:
flags Optional flags which control how a new instance of the application is started.
Returns:
true if registration is successful. false if another process was already running.

Definition at line 110 of file kuniqueapplication.cpp.


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

KDEUI

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

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • KIO
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • Kross
  • KUtils
  • Nepomuk
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.5.4
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