.TH "KStartupInfoData" kde3 "11 Jun 2005" "Version Version 3.4.1" "kdecore Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KStartupInfoData \- Class representing data about an application startup notification.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <kstartupinfo.h>\fP
.PP
Inherited by KStartupInfo::Data.
.PP
.SS "Public Types"

.in +1c
.ti -1c
.RI "enum \fBTriState\fP { \fBYes\fP, \fBNo\fP, \fBUnknown\fP }"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "void \fBsetBin\fP (const \fBQString\fP &bin)"
.br
.ti -1c
.RI "const \fBQString\fP & \fBbin\fP () const "
.br
.ti -1c
.RI "void \fBsetName\fP (const \fBQString\fP &name)"
.br
.ti -1c
.RI "const \fBQString\fP & \fBfindName\fP () const "
.br
.ti -1c
.RI "const \fBQString\fP & \fBname\fP () const "
.br
.ti -1c
.RI "void \fBsetDescription\fP (const \fBQString\fP &descr)"
.br
.ti -1c
.RI "const \fBQString\fP & \fBfindDescription\fP () const "
.br
.ti -1c
.RI "const \fBQString\fP & \fBdescription\fP () const "
.br
.ti -1c
.RI "void \fBsetIcon\fP (const \fBQString\fP &icon)"
.br
.ti -1c
.RI "const \fBQString\fP & \fBfindIcon\fP () const "
.br
.ti -1c
.RI "const \fBQString\fP & \fBicon\fP () const "
.br
.ti -1c
.RI "void \fBsetDesktop\fP (int desktop)"
.br
.ti -1c
.RI "int \fBdesktop\fP () const "
.br
.ti -1c
.RI "void \fBsetWMClass\fP (const \fBQCString\fP &wmclass)"
.br
.ti -1c
.RI "const \fBQCString\fP \fBfindWMClass\fP () const "
.br
.ti -1c
.RI "const \fBQCString\fP & \fBWMClass\fP () const "
.br
.ti -1c
.RI "void \fBaddPid\fP (pid_t pid)"
.br
.ti -1c
.RI "const \fBQValueList\fP< pid_t > & \fBpids\fP () const "
.br
.ti -1c
.RI "bool \fBis_pid\fP (pid_t pid) const "
.br
.ti -1c
.RI "void \fBsetHostname\fP (const \fBQCString\fP &hostname=\fBQCString\fP())"
.br
.ti -1c
.RI "const \fBQCString\fP & \fBhostname\fP () const "
.br
.ti -1c
.RI "void \fBsetSilent\fP (TriState state)"
.br
.ti -1c
.RI "TriState \fBsilent\fP () const "
.br
.ti -1c
.RI "void \fBsetTimestamp\fP (unsigned long time)"
.br
.ti -1c
.RI "unsigned long \fBtimestamp\fP () const "
.br
.ti -1c
.RI "int \fBscreen\fP () const "
.br
.ti -1c
.RI "void \fBsetScreen\fP (int screen)"
.br
.ti -1c
.RI "void \fBupdate\fP (const \fBKStartupInfoData\fP &data)"
.br
.ti -1c
.RI "\fBKStartupInfoData\fP ()"
.br
.ti -1c
.RI "\fBKStartupInfoData\fP (const \fBKStartupInfoData\fP &data)"
.br
.ti -1c
.RI "\fBKStartupInfoData\fP & \fBoperator=\fP (const \fBKStartupInfoData\fP &data)"
.br
.in -1c
.SS "Friends"

.in +1c
.ti -1c
.RI "class \fBKStartupInfo\fP"
.br
.ti -1c
.RI "class \fBKStartupInfo::Data\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
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.
.PP
\fBSee also:\fP
.RS 4
\fBKStartupInfo\fP 
.PP
\fBKStartupInfoId\fP
.RE
.PP
\fBAuthor:\fP
.RS 4
Lubos Lunak <l.lunak@kde.org> 
.RE
.PP

.PP
Definition at line 463 of file kstartupinfo.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KStartupInfoData::KStartupInfoData ()"
.PP
Constructor. 
.PP
Initializes all the data to their default empty values.
.PP
Definition at line 1239 of file kstartupinfo.cpp.
.SS "KStartupInfoData::KStartupInfoData (const \fBKStartupInfoData\fP & data)"
.PP
Copy constructor. 
.PP

.PP
Definition at line 1197 of file kstartupinfo.cpp.
.SH "Member Function Documentation"
.PP 
.SS "void KStartupInfoData::setBin (const \fBQString\fP & bin)"
.PP
Sets the binary name of the application ( e.g. 
.PP
'kcontrol' ). 
.PP
\fBParameters:\fP
.RS 4
\fIbin\fP the new binary name of the application
.RE
.PP

.PP
Definition at line 1249 of file kstartupinfo.cpp.
.SS "const \fBQString\fP & KStartupInfoData::bin () const"
.PP
Returns the binary name of the starting application. 
.PP
\fBReturns:\fP
.RS 4
the new binary name of the application
.RE
.PP

.PP
Definition at line 1254 of file kstartupinfo.cpp.
.PP
Referenced by findIcon(), findName(), findWMClass(), and update().
.SS "void KStartupInfoData::setName (const \fBQString\fP & name)"
.PP
Sets the name for the notification (e.g. 
.PP
'Control Center')
.PP
Definition at line 1259 of file kstartupinfo.cpp.
.SS "const \fBQString\fP & KStartupInfoData::findName () const"
.PP
Returns the name of the startup notification. 
.PP
If it's not available, it tries to use other information (binary name). 
.PP
\fBReturns:\fP
.RS 4
the name of the startup notification
.RE
.PP

.PP
Definition at line 1269 of file kstartupinfo.cpp.
.PP
References bin(), QString::isEmpty(), and name().
.SS "const \fBQString\fP & KStartupInfoData::name () const"
.PP
Returns the name of the startup notification, or empty if not available. 
.PP
\fBReturns:\fP
.RS 4
the name of the startup notification, or an empty string if not set.
.RE
.PP

.PP
Definition at line 1264 of file kstartupinfo.cpp.
.PP
Referenced by findDescription(), findName(), and update().
.SS "void KStartupInfoData::setDescription (const \fBQString\fP & descr)"
.PP
Sets the description for the notification (e.g. 
.PP
'Launching Control Center'). I.e. \fBname()\fP describes what is being started, while \fBdescription()\fP is the actual action performed by the starting. 
.PP
\fBSince:\fP
.RS 4
3.2
.RE
.PP

.PP
Definition at line 1276 of file kstartupinfo.cpp.
.SS "const \fBQString\fP & KStartupInfoData::findDescription () const"
.PP
Returns the description of the startup notification. 
.PP
If it's not available, it returns \fBname()\fP. 
.PP
\fBReturns:\fP
.RS 4
the description of the startup notification 
.RE
.PP
\fBSince:\fP
.RS 4
3.2
.RE
.PP

.PP
Definition at line 1286 of file kstartupinfo.cpp.
.PP
References description(), QString::isEmpty(), and name().
.SS "const \fBQString\fP & KStartupInfoData::description () const"
.PP
Returns the name of the startup notification, or empty if not available. 
.PP
\fBReturns:\fP
.RS 4
the name of the startup notificaiton, or an empty string if not set. 
.RE
.PP
\fBSince:\fP
.RS 4
3.2
.RE
.PP

.PP
Definition at line 1281 of file kstartupinfo.cpp.
.PP
Referenced by findDescription(), and update().
.SS "void KStartupInfoData::setIcon (const \fBQString\fP & icon)"
.PP
Sets the icon for the startup notification ( e.g. 
.PP
'kcontrol' ) 
.PP
\fBParameters:\fP
.RS 4
\fIicon\fP the name of the icon
.RE
.PP

.PP
Definition at line 1293 of file kstartupinfo.cpp.
.SS "const \fBQString\fP & KStartupInfoData::findIcon () const"
.PP
Returns the icon of the startup notification, and if it's not available, tries to get it from the binary name. 
.PP
\fBReturns:\fP
.RS 4
the name of the startup notification's icon, or the name of the binary if not set
.RE
.PP

.PP
Definition at line 1298 of file kstartupinfo.cpp.
.PP
References bin(), icon(), and QString::isEmpty().
.SS "const \fBQString\fP & KStartupInfoData::icon () const"
.PP
Returns the icon of the startup notification, or empty if not available. 
.PP
\fBReturns:\fP
.RS 4
the name of the icon, or an empty string if not set.
.RE
.PP

.PP
Definition at line 1305 of file kstartupinfo.cpp.
.PP
Referenced by findIcon(), and update().
.SS "void KStartupInfoData::setDesktop (int desktop)"
.PP
Sets the desktop for the startup notification ( i.e. 
.PP
the desktop on which the starting application should appear ). 
.PP
\fBParameters:\fP
.RS 4
\fIdesktop\fP the desktop for the startup notification
.RE
.PP

.PP
Definition at line 1310 of file kstartupinfo.cpp.
.SS "int KStartupInfoData::desktop () const"
.PP
Returns the desktop for the startup notification. 
.PP
\fBReturns:\fP
.RS 4
the desktop for the startup notification
.RE
.PP

.PP
Definition at line 1315 of file kstartupinfo.cpp.
.PP
Referenced by update().
.SS "void KStartupInfoData::setWMClass (const \fBQCString\fP & wmclass)"
.PP
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. 
.PP
\fBParameters:\fP
.RS 4
\fIwmclass\fP the WM_CLASS value for the startup notification
.RE
.PP

.PP
Definition at line 1320 of file kstartupinfo.cpp.
.SS "const \fBQCString\fP KStartupInfoData::findWMClass () const"
.PP
Returns the WM_CLASS value for the startup notification, or binary name if not available. 
.PP
\fBReturns:\fP
.RS 4
the WM_CLASS value for the startup notification, or the binary name if not set
.RE
.PP

.PP
Definition at line 1325 of file kstartupinfo.cpp.
.PP
References bin(), QCString::isEmpty(), QString::utf8(), and WMClass().
.SS "const \fBQCString\fP & KStartupInfoData::WMClass () const"
.PP
Returns the WM_CLASS value for the startup notification, or empty if not available. 
.PP
\fBReturns:\fP
.RS 4
the WM_CLASS value for the startup notification, or empty if not set
.RE
.PP

.PP
Definition at line 1332 of file kstartupinfo.cpp.
.PP
Referenced by findWMClass().
.SS "void KStartupInfoData::addPid (pid_t pid)"
.PP
Adds a PID to the list of processes that belong to the startup notification. 
.PP
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. 
.PP
\fBParameters:\fP
.RS 4
\fIpid\fP the PID to add
.RE
.PP

.PP
Definition at line 1356 of file kstartupinfo.cpp.
.PP
References QCString::append().
.PP
Referenced by KUniqueApplication::start(), and update().
.SS "const \fBQValueList\fP< pid_t > & KStartupInfoData::pids () const"
.PP
Returns all PIDs for the startup notification. 
.PP
\fBReturns:\fP
.RS 4
the list of all PIDs
.RE
.PP

.PP
Definition at line 1367 of file kstartupinfo.cpp.
.SS "bool KStartupInfoData::is_pid (pid_t pid) const"
.PP
Checks whether the given \fCpid\fP is in the list of PIDs for starup notification. 
.PP
\fBReturns:\fP
.RS 4
true if the given \fCpid\fP is in the list of PIDs for the startup notification
.RE
.PP

.PP
Definition at line 1372 of file kstartupinfo.cpp.
.PP
References QValueList::contains().
.SS "void KStartupInfoData::setHostname (const \fBQCString\fP & hostname = \fC\fBQCString\fP()\fP)"
.PP
Sets the hostname on which the application is starting. 
.PP
It's necessary to set it if PIDs are set. 
.PP
\fBParameters:\fP
.RS 4
\fIhostname\fP the application's hostname. If it's a null string, the current hostname is used
.RE
.PP

.PP
Definition at line 1337 of file kstartupinfo.cpp.
.SS "const \fBQCString\fP & KStartupInfoData::hostname () const"
.PP
Returns the hostname for the startup notification. 
.PP
\fBReturns:\fP
.RS 4
the hostname
.RE
.PP

.PP
Definition at line 1351 of file kstartupinfo.cpp.
.SS "void KStartupInfoData::setSilent (TriState state)"
.PP
Sets whether the visual feedback for this startup notification should be silenced (temporarily suspended). 
.PP
\fBSince:\fP
.RS 4
3.1.1
.RE
.PP

.PP
Definition at line 1377 of file kstartupinfo.cpp.
.PP
Referenced by KStartupInfo::silenceStartup().
.SS "KStartupInfoData::TriState KStartupInfoData::silent () const"
.PP
Return the silence status for the startup notification. 
.PP
\fBReturns:\fP
.RS 4
KStartupInfoData::Yes if visual feedback is silenced 
.RE
.PP
\fBSince:\fP
.RS 4
3.1.1
.RE
.PP

.PP
Definition at line 1382 of file kstartupinfo.cpp.
.SS "void KStartupInfoData::setTimestamp (unsigned long time)"
.PP
\fBDeprecated\fP
.RS 4
Timestamp is already assigned in \fBKStartupInfoId::initId()\fP. 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. 
.RE
.PP

.PP
Definition at line 1387 of file kstartupinfo.cpp.
.SS "unsigned long KStartupInfoData::timestamp () const"
.PP
\fBDeprecated\fP
.RS 4
Use \fBKStartupInfoId::timestamp()\fP. Return the timestamp for the startup notification, or -1 if no timestamp is set. 
.RE
.PP

.PP
Definition at line 1392 of file kstartupinfo.cpp.
.PP
Referenced by update().
.SS "int KStartupInfoData::screen () const"
.PP
The X11 screen on which the startup notification is happening, -1 if unknown. 
.PP
Definition at line 1402 of file kstartupinfo.cpp.
.SS "void KStartupInfoData::setScreen (int screen)"
.PP
Sets the X11 screen on which the startup notification should happen. 
.PP
This is usually not necessary to set, as it's set by default to qt_xscreen(). 
.PP
Definition at line 1397 of file kstartupinfo.cpp.
.SS "void KStartupInfoData::update (const \fBKStartupInfoData\fP & data)"
.PP
Updates the notification data from the given data. 
.PP
Some data, such as the desktop or the name, won't be rewritten if already set. 
.PP
\fBParameters:\fP
.RS 4
\fIdata\fP the data to update
.RE
.PP

.PP
Definition at line 1211 of file kstartupinfo.cpp.
.PP
References addPid(), bin(), QString::d(), description(), desktop(), QValueList::end(), icon(), QString::isEmpty(), name(), and timestamp().

.SH "Author"
.PP 
Generated automatically by Doxygen for kdecore Library from the source code.
