• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdelibs-4.10.5 API Reference
  • KDE Home
  • Contact Us
 

KDEUI

Public Types | Signals | Public Member Functions | Static Public Member Functions | Protected Member Functions
KStartupInfo Class Reference

#include <kstartupinfo.h>

Inheritance diagram for KStartupInfo:
QObject

List of all members.

Public Types

enum  { CleanOnCantDetect = 1 << 0, DisableKWinModule = 1 << 1, AnnounceSilenceChanges = 1 << 2 }
enum  startup_t { NoMatch, Match, CantDetect }

Signals

void gotNewStartup (const KStartupInfoId &id, const KStartupInfoData &data)
void gotRemoveStartup (const KStartupInfoId &id, const KStartupInfoData &data)
void gotStartupChange (const KStartupInfoId &id, const KStartupInfoData &data)

Public Member Functions

 KStartupInfo (int flags, QObject *parent=0)
 KStartupInfo (bool clean_on_cantdetect, QObject *parent=0)
virtual ~KStartupInfo ()
startup_t checkStartup (WId w)
startup_t checkStartup (WId w, KStartupInfoId &id)
startup_t checkStartup (WId w, KStartupInfoData &data)
startup_t checkStartup (WId w, KStartupInfoId &id, KStartupInfoData &data)
void setTimeout (unsigned int secs)

Static Public Member Functions

static void appStarted ()
static void appStarted (const QByteArray &startup_id)
static QByteArray createNewStartupId ()
static KStartupInfoId currentStartupIdEnv ()
static void disableAutoAppStartedSending (bool disable=true)
static void handleAutoAppStartedSending ()
static void resetStartupEnv ()
static bool sendChange (const KStartupInfoId &id, const KStartupInfoData &data)
static bool sendChangeX (Display *dpy, const KStartupInfoId &id, const KStartupInfoData &data)
static bool sendFinish (const KStartupInfoId &id)
static bool sendFinish (const KStartupInfoId &id, const KStartupInfoData &data)
static bool sendFinishX (Display *dpy, const KStartupInfoId &id)
static bool sendFinishX (Display *dpy, const KStartupInfoId &id, const KStartupInfoData &data)
static bool sendStartup (const KStartupInfoId &id, const KStartupInfoData &data)
static bool sendStartupX (Display *dpy, const KStartupInfoId &id, const KStartupInfoData &data)
static void setNewStartupId (QWidget *window, const QByteArray &startup_id)
static void setWindowStartupId (WId window, const QByteArray &id)
static void silenceStartup (bool silence)
static QByteArray windowStartupId (WId w)

Protected Member Functions

virtual void customEvent (QEvent *e_P)

Detailed Description

Class for manipulating the application startup notification.

This class can be used to send information about started application, change the information and receive this information. For detailed description, see kdelibs/kdecore/README.kstartupinfo.

You usually don't need to use this class for sending the notification information, as KDE libraries should do this when an application is started (e.g. KRun class).

For receiving the startup notification info, create an instance and connect to its slots. It will automatically detect started applications and when they are ready.

See also:
KStartupInfoId
KStartupInfoData
Author:
Lubos Lunak l.lun.nosp@m.ak@k.nosp@m.de.or.nosp@m.g

Definition at line 64 of file kstartupinfo.h.


Member Enumeration Documentation

anonymous enum
Enumerator:
CleanOnCantDetect 
DisableKWinModule 
AnnounceSilenceChanges 

Definition at line 121 of file kstartupinfo.h.

enum KStartupInfo::startup_t
  • NoMatch - the window doesn't match any existing startup notification
  • Match - the window matches an existing startup notification
  • CantDetect - unable to detect if the window matches any existing startup notification
Enumerator:
NoMatch 
Match 
CantDetect 

Definition at line 255 of file kstartupinfo.h.


Constructor & Destructor Documentation

KStartupInfo::KStartupInfo ( int  flags,
QObject *  parent = 0 
)
explicit

Creates an instance that will receive the startup notifications.

The various flags passed may be

  • CleanOnCantDetect - when a new unknown window appears, all startup notifications for applications that are not compliant with the startup protocol are removed
  • DisableKWinModule - KWinModule, which is normally used to detect new windows, is disabled. With this flag, checkStartup() must be called in order to check newly mapped windows.
  • AnnounceSilenceChanges - normally, startup notifications are "removed" when they're silenced, and "recreated" when they're resumed. With this flag, the change is normally announced with gotStartupChange().
Parameters:
flagsOR-ed combination of flags
parentthe parent of this QObject (can be 0 for no parent)

Definition at line 203 of file kstartupinfo.cpp.

KStartupInfo::KStartupInfo ( bool  clean_on_cantdetect,
QObject *  parent = 0 
)
explicit

Creates an instance that will receive the startup notifications.

Parameters:
clean_on_cantdetectif true, and a new unknown window appears, removes all notification for applications that are not compliant with the app startup protocol
parentthe parent of this QObject (can be 0 for no parent)
Deprecated:

Definition at line 210 of file kstartupinfo.cpp.

KStartupInfo::~KStartupInfo ( )
virtual

Definition at line 218 of file kstartupinfo.cpp.


Member Function Documentation

void KStartupInfo::appStarted ( )
static

Manual notification that the application has started.

If you do not map a (toplevel) window, then startup notification will not disappear for the application until a timeout. You can use this as an alternative method in this case.

Definition at line 586 of file kstartupinfo.cpp.

void KStartupInfo::appStarted ( const QByteArray &  startup_id)
static

Sends explicit notification that the startup notification with id startup_id should end.

Definition at line 600 of file kstartupinfo.cpp.

KStartupInfo::startup_t KStartupInfo::checkStartup ( WId  w)

Checks if the given windows matches any existing startup notification.

Parameters:
wthe window id to check
Returns:
the result of the operation

Definition at line 689 of file kstartupinfo.cpp.

KStartupInfo::startup_t KStartupInfo::checkStartup ( WId  w,
KStartupInfoId &  id 
)

Checks if the given windows matches any existing startup notification, and if yes, returns the identification in id.

Parameters:
wthe window id to check
idif found, the id of the startup notification will be written here
Returns:
the result of the operation

Definition at line 679 of file kstartupinfo.cpp.

KStartupInfo::startup_t KStartupInfo::checkStartup ( WId  w,
KStartupInfoData &  data 
)

Checks if the given windows matches any existing startup notification, and if yes, returns the notification data in data.

Parameters:
wthe window id to check
dataif found, the data of the startup notification will be written here
Returns:
the result of the operation

Definition at line 684 of file kstartupinfo.cpp.

KStartupInfo::startup_t KStartupInfo::checkStartup ( WId  w,
KStartupInfoId &  id,
KStartupInfoData &  data 
)

Checks if the given windows matches any existing startup notification, and if yes, returns the identification in id and notification data in data.

Parameters:
wthe window id to check
idif found, the id of the startup notification will be written here
dataif found, the data of the startup notification will be written here
Returns:
the result of the operation

Definition at line 673 of file kstartupinfo.cpp.

QByteArray KStartupInfo::createNewStartupId ( )
static

Creates and returns new startup id.

The id includes properly setup user timestamp.

Definition at line 1012 of file kstartupinfo.cpp.

KStartupInfoId KStartupInfo::currentStartupIdEnv ( )
static

Returns the current startup notification identification for the current startup notification environment variable.

Note that KApplication constructor unsets the variable and you have to use KApplication::startupId .

Returns:
the current startup notification identification

Definition at line 1090 of file kstartupinfo.cpp.

void KStartupInfo::customEvent ( QEvent *  e_P)
protectedvirtual

Definition at line 266 of file kstartupinfo.cpp.

void KStartupInfo::disableAutoAppStartedSending ( bool  disable = true)
static

By default, the startup notification is ended for the application after it shows its first toplevel window.

If you app e.g. has several toplevel windows after its startup, you can disable the automatic handling, and call appStarted() manually after all toplevel windows have been shown.

Definition at line 621 of file kstartupinfo.cpp.

void KStartupInfo::gotNewStartup ( const KStartupInfoId &  id,
const KStartupInfoData &  data 
)
signal

Emitted when a new startup notification is created (i.e.

a new application is being started).

Parameters:
idthe notification identification
datathe notification data
void KStartupInfo::gotRemoveStartup ( const KStartupInfoId &  id,
const KStartupInfoData &  data 
)
signal

Emitted when a startup notification is removed (either because it was detected that the application is ready or because of a timeout).

Parameters:
idthe notification identification
datathe notification data
void KStartupInfo::gotStartupChange ( const KStartupInfoId &  id,
const KStartupInfoData &  data 
)
signal

Emitted when a startup notification changes.

Parameters:
idthe notification identification
datathe notification data
void KStartupInfo::handleAutoAppStartedSending ( )
static

Definition at line 637 of file kstartupinfo.cpp.

void KStartupInfo::resetStartupEnv ( )
static

Unsets the startup notification environment variable.

Definition at line 1101 of file kstartupinfo.cpp.

bool KStartupInfo::sendChange ( const KStartupInfoId &  id,
const KStartupInfoData &  data 
)
static

Sends given notification data about started application with the given startup identification.

This is used for updating the notification info, if no notification for this identification exists, it's ignored.

Parameters:
idthe id of the application
datathe application's data
Returns:
true if successful, false otherwise
See also:
KStartupInfoId
KStartupInfoData

Definition at line 496 of file kstartupinfo.cpp.

bool KStartupInfo::sendChangeX ( Display *  dpy,
const KStartupInfoId &  id,
const KStartupInfoData &  data 
)
static

Like sendChange , uses dpy instead of qt_x11display() for sending the info.

Parameters:
dpythe display of the application.
idthe id of the application
datathe application's data
Returns:
true if successful, false otherwise

Definition at line 510 of file kstartupinfo.cpp.

bool KStartupInfo::sendFinish ( const KStartupInfoId &  id)
static

Ends startup notification with the given identification.

Parameters:
idthe id of the application
Returns:
true if successful, false otherwise

Definition at line 527 of file kstartupinfo.cpp.

bool KStartupInfo::sendFinish ( const KStartupInfoId &  id,
const KStartupInfoData &  data 
)
static

Ends startup notification with the given identification and the given data ( e.g.

PIDs of processes for this startup notification that exited ).

Parameters:
idthe id of the application
datathe application's data
Returns:
true if successful, false otherwise

Definition at line 555 of file kstartupinfo.cpp.

bool KStartupInfo::sendFinishX ( Display *  dpy,
const KStartupInfoId &  id 
)
static

Like sendFinish , uses dpy instead of qt_x11display() for sending the info.

Parameters:
dpythe display of the application.
idthe id of the application
Returns:
true if successful, false otherwise

Definition at line 540 of file kstartupinfo.cpp.

bool KStartupInfo::sendFinishX ( Display *  dpy,
const KStartupInfoId &  id,
const KStartupInfoData &  data 
)
static

Like sendFinish , uses dpy instead of qt_x11display() for sending the info.

Parameters:
dpythe display of the application.
idthe id of the application
datathe application's data
Returns:
true if successful, false otherwise

Definition at line 569 of file kstartupinfo.cpp.

bool KStartupInfo::sendStartup ( const KStartupInfoId &  id,
const KStartupInfoData &  data 
)
static

Sends given notification data about started application with the given startup identification.

If no notification for this identification exists yet, it is created, otherwise it's updated. Note that the name field in data is required.

Parameters:
idthe id of the application
datathe application's data
Returns:
true if successful, false otherwise
See also:
KStartupInfoId
KStartupInfoData

Definition at line 445 of file kstartupinfo.cpp.

bool KStartupInfo::sendStartupX ( Display *  dpy,
const KStartupInfoId &  id,
const KStartupInfoData &  data 
)
static

Like sendStartup , uses dpy instead of qt_x11display() for sending the info.

Parameters:
dpythe display of the application. Note that the name field in data is required.
idthe id of the application
datathe application's data
Returns:
true if successful, false otherwise

Definition at line 461 of file kstartupinfo.cpp.

void KStartupInfo::setNewStartupId ( QWidget *  window,
const QByteArray &  startup_id 
)
static

Use this function if the application got a request with startup notification from outside (for example, when KUniqueApplication::newInstance() is called, or e.g.

when khelpcenter opens new URL in its window). The window can be either an already existing and visible window, or a new one, before being shown. Note that this function is usually needed only when a window is reused.

Definition at line 643 of file kstartupinfo.cpp.

void KStartupInfo::setTimeout ( unsigned int  secs)

Sets the timeout for notifications, after this timeout a notification is removed.

Parameters:
secsthe new timeout in seconds

Definition at line 910 of file kstartupinfo.cpp.

void KStartupInfo::setWindowStartupId ( WId  window,
const QByteArray &  id 
)
static

Sets the startup notification window property on the given window.

Parameters:
windowthe id of the window
idthe startup notification id

Definition at line 874 of file kstartupinfo.cpp.

void KStartupInfo::silenceStartup ( bool  silence)
static

If your application shows temporarily some window during its startup, for example a dialog, and only after closing it shows the main window, startup notification would normally be shown while the dialog is visible.

To temporarily suspend and resume the notification, use this function. Note that this is cumulative, i.e. after suspending twice, you have to resume twice.

Definition at line 626 of file kstartupinfo.cpp.

QByteArray KStartupInfo::windowStartupId ( WId  w)
static

Returns startup notification identification of the given window.

Parameters:
wthe id of the window
Returns:
the startup notification id. Can be null if not found.

Definition at line 852 of file kstartupinfo.cpp.


The documentation for this class was generated from the following files:
  • kstartupinfo.h
  • kstartupinfo.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2013 The KDE developers.
Generated on Tue Jul 23 2013 20:34:22 by doxygen 1.8.1.1 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KDEUI

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

kdelibs-4.10.5 API Reference

Skip menu "kdelibs-4.10.5 API Reference"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
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