KStartupInfoData Class Reference

#include <kstartupinfo.h>

Inherited by KStartupInfo::Data.

Public Types
enum	TriState { Yes, No, Unknown }

Public Member Functions
	KStartupInfoData ()
	KStartupInfoData (const KStartupInfoData &data)
	~KStartupInfoData ()
void	addPid (pid_t pid)
QString	applicationId () const
const QString &	bin () const
const QString &	description () const
int	desktop () const
const QString &	findDescription () const
const QString &	findIcon () const
const QString &	findName () const
const QByteArray	findWMClass () const
QByteArray	hostname () const
const QString &	icon () const
bool	is_pid (pid_t pid) const
WId	launchedBy () const
const QString &	name () const
KStartupInfoData &	operator= (const KStartupInfoData &data)
QList< pid_t >	pids () const
int	screen () const
void	setApplicationId (const QString &desktop)
void	setBin (const QString &bin)
void	setDescription (const QString &descr)
void	setDesktop (int desktop)
void	setHostname (const QByteArray &hostname=QByteArray())
void	setIcon (const QString &icon)
void	setLaunchedBy (WId window)
void	setName (const QString &name)
void	setScreen (int screen)
void	setSilent (TriState state)
void	setTimestamp (unsigned long time)
void	setWMClass (const QByteArray &wmclass)
void	setXinerama (int xinerama)
TriState	silent () const
unsigned long	timestamp () const
void	update (const KStartupInfoData &data)
QByteArray	WMClass () const
int	xinerama () const

Detailed Description

Class representing data about an application startup notification.

Such data include the icon of the starting application, the desktop on which the application should start, the binary name of the application, etc.

See also

KStartupInfo

KStartupInfoId

Author

Lubos Lunak l.lun.nosp@m.ak@k.nosp@m.de.or.nosp@m.g

Definition at line 439 of file kstartupinfo.h.

Member Enumeration Documentation

enum KStartupInfoData::TriState

Enumerator
Yes
No
Unknown

Definition at line 568 of file kstartupinfo.h.

Constructor & Destructor Documentation

KStartupInfoData::KStartupInfoData

(

)

Constructor.

Initializes all the data to their default empty values.

Definition at line 1330 of file kstartupinfo.cpp.

KStartupInfoData::KStartupInfoData

(

const KStartupInfoData &

data

)

Copy constructor.

Definition at line 1284 of file kstartupinfo.cpp.

KStartupInfoData::~KStartupInfoData

(

)

Definition at line 1334 of file kstartupinfo.cpp.

Member Function Documentation

void KStartupInfoData::addPid

(

pid_t

pid

)

Adds a PID to the list of processes that belong to the startup notification.

It may be used to increase the chance that the windows created by the starting application will be detected correctly, and also for detecting if the application has quit without creating any window.

Parameters

pid	the PID to add

Definition at line 1446 of file kstartupinfo.cpp.

QString KStartupInfoData::applicationId

(

)

const

The .desktop file used to initiate this startup notification, or empty.

This information should be used only to identify the application, not to read any additional information.

Since

4.5

Definition at line 1533 of file kstartupinfo.cpp.

const QString & KStartupInfoData::bin

(

)

const

Returns the binary name of the starting application.

Returns

the new binary name of the application

Definition at line 1344 of file kstartupinfo.cpp.

const QString & KStartupInfoData::description

(

)

const

Returns the name of the startup notification, or empty if not available.

Returns

the name of the startup notificaiton, or an empty string if not set.

Definition at line 1371 of file kstartupinfo.cpp.

int KStartupInfoData::desktop

(

)

const

Returns the desktop for the startup notification.

Returns

the desktop for the startup notification

Definition at line 1405 of file kstartupinfo.cpp.

const QString & KStartupInfoData::findDescription

(

)

const

Returns the description of the startup notification.

If it's not available, it returns name().

Returns

the description of the startup notification

Definition at line 1376 of file kstartupinfo.cpp.

const QString & KStartupInfoData::findIcon

(

)

const

Returns the icon of the startup notification, and if it's not available, tries to get it from the binary name.

Returns

the name of the startup notification's icon, or the name of the binary if not set

Definition at line 1388 of file kstartupinfo.cpp.

const QString & KStartupInfoData::findName

(

)

const

Returns the name of the startup notification.

If it's not available, it tries to use other information (binary name).

Returns

the name of the startup notification

Definition at line 1359 of file kstartupinfo.cpp.

const QByteArray KStartupInfoData::findWMClass

(

)

const

Returns the WM_CLASS value for the startup notification, or binary name if not available.

Returns

the WM_CLASS value for the startup notification, or the binary name if not set

Definition at line 1415 of file kstartupinfo.cpp.

QByteArray KStartupInfoData::hostname

(

)

const

Returns the hostname for the startup notification.

Returns

the hostname

Definition at line 1441 of file kstartupinfo.cpp.

const QString & KStartupInfoData::icon

(

)

const

Returns the icon of the startup notification, or empty if not available.

Returns

the name of the icon, or an empty string if not set.

Definition at line 1395 of file kstartupinfo.cpp.

bool KStartupInfoData::is_pid

(

pid_t

pid

)

const

Checks whether the given pid is in the list of PIDs for starup notification.

Returns

true if the given pid is in the list of PIDs for the startup notification

Definition at line 1462 of file kstartupinfo.cpp.

WId KStartupInfoData::launchedBy

(

)

const

The toplevel window of the application that caused this startup notification, 0 if unknown.

Definition at line 1512 of file kstartupinfo.cpp.

const QString & KStartupInfoData::name

(

)

const

Returns the name of the startup notification, or empty if not available.

Returns

the name of the startup notification, or an empty string if not set.

Definition at line 1354 of file kstartupinfo.cpp.

KStartupInfoData & KStartupInfoData::operator=

(

const KStartupInfoData &

data

)

Definition at line 1288 of file kstartupinfo.cpp.

QList< pid_t > KStartupInfoData::pids

(

)

const

Returns all PIDs for the startup notification.

Returns

the list of all PIDs

Definition at line 1457 of file kstartupinfo.cpp.

int KStartupInfoData::screen

(

)

const

The X11 screen on which the startup notification is happening, -1 if unknown.

Definition at line 1492 of file kstartupinfo.cpp.

void KStartupInfoData::setApplicationId

(

const QString &

desktop

)

Sets the .desktop file that was used to initiate the startup notification.

Since

4.5

Definition at line 1517 of file kstartupinfo.cpp.

void KStartupInfoData::setBin

(

const QString &

bin

)

Sets the binary name of the application ( e.g.

'kcontrol' ).

Parameters

bin	the new binary name of the application

Definition at line 1339 of file kstartupinfo.cpp.

void KStartupInfoData::setDescription

(

const QString &

descr

)

Sets the description for the notification (e.g.

'Launching Control Center'). I.e. name() describes what is being started, while description() is the actual action performed by the starting.

Definition at line 1366 of file kstartupinfo.cpp.

void KStartupInfoData::setDesktop

(

int

desktop

)

Sets the desktop for the startup notification ( i.e.

the desktop on which the starting application should appear ).

Parameters

desktop

the desktop for the startup notification

Definition at line 1400 of file kstartupinfo.cpp.

void KStartupInfoData::setHostname

(

const QByteArray &

hostname = QByteArray()

)

Sets the hostname on which the application is starting.

It's necessary to set it if PIDs are set.

Parameters

hostname

the application's hostname. If it's a null string, the current hostname is used

Definition at line 1427 of file kstartupinfo.cpp.

void KStartupInfoData::setIcon

(

const QString &

icon

)

Sets the icon for the startup notification ( e.g.

'kcontrol' )

Parameters

icon	the name of the icon

Definition at line 1383 of file kstartupinfo.cpp.

void KStartupInfoData::setLaunchedBy

(

WId

window

)

Sets the toplevel window of the application that caused this startup notification.

Parameters

window

window ID of the toplevel window that is responsible for this startup

Definition at line 1507 of file kstartupinfo.cpp.

void KStartupInfoData::setName

(

const QString &

name

)

Sets the name for the notification (e.g.

'Control Center')

Definition at line 1349 of file kstartupinfo.cpp.

void KStartupInfoData::setScreen

(

int

screen

)

Sets the X11 screen on which the startup notification should happen.

This is usually not necessary to set, as it's set by default to QX11Info::screen().

Definition at line 1487 of file kstartupinfo.cpp.

void KStartupInfoData::setSilent

(

TriState

state

)

Sets whether the visual feedback for this startup notification should be silenced (temporarily suspended).

Definition at line 1467 of file kstartupinfo.cpp.

void KStartupInfoData::setTimestamp

(

unsigned long

time

)

Deprecated:

Timestamp is already assigned in KStartupInfoId::initId(). Sets timestamp for the startup notification. The timestamp is expressed as XServer time, and is used to prevent activation of the matching window if user interaction took place after this timestamp. Value -1 means no timestamp set, value 0 means that the window should not be activated.

Definition at line 1477 of file kstartupinfo.cpp.

void KStartupInfoData::setWMClass

(

const QByteArray &

wmclass

)

Sets a WM_CLASS value for the startup notification, it may be used for increasing the chance that the windows created by the starting application will be detected correctly.

Parameters

wmclass

the WM_CLASS value for the startup notification

Definition at line 1410 of file kstartupinfo.cpp.

void KStartupInfoData::setXinerama

(

int

xinerama

)

Sets the Xinerama screen for the startup notification ( i.e.

the screeen on which the starting application should appear ).

Parameters

xinerama

the Xinerama screen for the startup notification

Definition at line 1497 of file kstartupinfo.cpp.

KStartupInfoData::TriState KStartupInfoData::silent

(

)

const

Return the silence status for the startup notification.

Returns

KStartupInfoData::Yes if visual feedback is silenced

Definition at line 1472 of file kstartupinfo.cpp.

unsigned long KStartupInfoData::timestamp

(

)

const

Deprecated:

Use KStartupInfoId::timestamp(). Return the timestamp for the startup notification, or -1 if no timestamp is set.

Definition at line 1482 of file kstartupinfo.cpp.

void KStartupInfoData::update

(

const KStartupInfoData &

data

)

Updates the notification data from the given data.

Some data, such as the desktop or the name, won't be rewritten if already set.

Parameters

data	the data to update

Definition at line 1296 of file kstartupinfo.cpp.

QByteArray KStartupInfoData::WMClass

(

)

const

Returns the WM_CLASS value for the startup notification, or empty if not available.

Returns

the WM_CLASS value for the startup notification, or empty if not set

Definition at line 1422 of file kstartupinfo.cpp.

int KStartupInfoData::xinerama

(

)

const

The Xinerama screen for the startup notification, -1 if unknown.

Definition at line 1502 of file kstartupinfo.cpp.

---

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

• kstartupinfo.h
• kstartupinfo.cpp