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

KDECore

KAutostart Class Reference

KAutostart provides a programmatic means to control the state of autostart services on a per-user basis. More...

#include <kautostart.h>

Inheritance diagram for KAutostart:
QObject

List of all members.

Public Types

enum  Condition { NoConditions = 0x0, CheckCommand = 0x1, CheckCondition = 0x2, CheckAll = 0xff }
enum  StartPhase { BaseDesktop = 0, DesktopServices = 1, Applications = 2 }

Public Member Functions

void addToAllowedEnvironments (const QString &environment)
void addToExcludedEnvironments (const QString &environment)
QStringList allowedEnvironments () const
bool autostarts (const QString &environment=QString(), Conditions check=NoConditions) const
bool checkAllowedEnvironment (const QString &environment) const
QString command () const
QString commandToCheck () const
QStringList excludedEnvironments () const
 KAutostart (const QString &entryName=QString(), QObject *parent=0)
void removeFromAllowedEnvironments (const QString &environment)
void removeFromExcludedEnvironments (const QString &environment)
void setAllowedEnvironments (const QStringList &environments)
void setAutostarts (bool autostart)
void setCommand (const QString &command)
void setCommandToCheck (const QString &exec)
void setExcludedEnvironments (const QStringList &environments)
void setStartPhase (StartPhase phase)
void setVisibleName (const QString &entryName)
QString startAfter () const
StartPhase startPhase () const
QString visibleName () const
 ~KAutostart ()

Static Public Member Functions

static bool isServiceRegistered (const QString &entryName)

Detailed Description

KAutostart provides a programmatic means to control the state of autostart services on a per-user basis.

This is useful for applications that wish to offer a configurable means to allow the application to be autostarted.

By using this class you future-proof your applications against potential future or platform-specific changes to the autostart mechanism(s).

Typical usage might look like:

 KAutostart autostart; // without an entryName arg, gets name from KAboutData
 autostart.setAutostarts(true); // will now start up when the user logs in

 // set the value in our configuration settings to reflect whether or not
 // we will actually start up on log in
 config.setAutoStart(autostart.autoStarts());

Definition at line 49 of file kautostart.h.


Member Enumeration Documentation

enum KAutostart::Condition

Flags for each of the conditions that may affect whether or not a service actually autostarted on login.

Enumerator:
NoConditions 
CheckCommand 

an executable that is checked for existence by name

CheckCondition 

autostart condition will be checked too (KDE-specific)

Since:
4.3
CheckAll 

all necessary conditions will be checked

Since:
4.3

Definition at line 80 of file kautostart.h.

enum KAutostart::StartPhase

Enumerates the various autostart phases that occur during start-up.

Enumerator:
BaseDesktop 

the essential desktop services such as panels and window managers

DesktopServices 

services that should be available before most interactive applications start but that aren't part of the base desktop.

This would include things such as clipboard managers and mouse gesture tools.

Applications 

everything else that doesn't belong in the above two categories, including most system tray applications, system monitors and interactive applications

Definition at line 103 of file kautostart.h.


Constructor & Destructor Documentation

KAutostart::KAutostart ( const QString &  entryName = QString(),
QObject *  parent = 0 
) [explicit]

Creates a new KAutostart object that represents the autostart service "entryName".

If the service already exists in the system then the values associated with that service, such as the executable command, will be loaded as well.

Note that unless this service is explicitly set to autostart, simply creating a KAutostart object will not result in the service being autostarted on next log in.

If no such service is already registered and the command to be executed on startup is not the same as entryName, then you will want to set the associated command with setExec(const QString&)

See also:
setExec
Parameters:
entryName the name used to identify the service. If none is provided then it uses the name registered with KAboutData.
parent QObject

Definition at line 49 of file kautostart.cpp.

KAutostart::~KAutostart (  ) 

Definition at line 72 of file kautostart.cpp.


Member Function Documentation

void KAutostart::addToAllowedEnvironments ( const QString &  environment  ) 

Adds an environment to the list of environments this service may start in.

See also:
setAllowedEnvironments(), removeFromAllowedEnvironments()

Definition at line 225 of file kautostart.cpp.

void KAutostart::addToExcludedEnvironments ( const QString &  environment  ) 

Adds an environment to the list of environments this service may not be autostarted in.

See also:
removeFromExcludedEnvironments()

Definition at line 262 of file kautostart.cpp.

QStringList KAutostart::allowedEnvironments (  )  const

Returns the list of environments (e.g.

"KDE") this service is allowed to start in. Use checkAllowedEnvironment() or autostarts() for actual checks.

This does not take other autostart conditions into account. If any environment is added to the allowed environments list, then only those environments will be allowed to autoload the service. It is not allowed to specify both allowed and excluded environments at the same time.

See also:
setAllowedEnvironments()

Definition at line 215 of file kautostart.cpp.

bool KAutostart::autostarts ( const QString &  environment = QString(),
Conditions  check = NoConditions 
) const

Returns whether or not the service represented by entryName in the autostart system is set to autostart at login or not.

Parameters:
environment if provided the check will be performed as if being loaded in that environment
check autostart conditions to check for (see commandToCheck())
See also:
setAutostarts()

Definition at line 82 of file kautostart.cpp.

bool KAutostart::checkAllowedEnvironment ( const QString &  environment  )  const

Checks whether autostart is allowed in the given environment, depending on allowedEnvironments() and excludedEnvironments().

Since:
4.3

Definition at line 128 of file kautostart.cpp.

QString KAutostart::command (  )  const

Returns the associated command for this autostart service.

See also:
setCommand()

Definition at line 139 of file kautostart.cpp.

QString KAutostart::commandToCheck (  )  const

Returns the executable to check for when attempting to autostart this service.

If the executable is not found in the user's environment, it will not autostart.

See also:
setCommandToCheck()

Definition at line 164 of file kautostart.cpp.

QStringList KAutostart::excludedEnvironments (  )  const

Returns the list of environments this service is explicitly not allowed to start in.

Use checkAllowedEnvironment() or autostarts() for actual checks.

This does not take other autostart conditions such as into account. It is not allowed to specify both allowed and excluded environments at the same time.

See also:
setExcludedEnvironments()

Definition at line 252 of file kautostart.cpp.

bool KAutostart::isServiceRegistered ( const QString &  entryName  )  [static]

Checks whether or not a service by the given name entryName is registered with the autostart system.

Does not check whether or not it is set to actually autostart or not.

Parameters:
entryName the name of the service to check for

Definition at line 159 of file kautostart.cpp.

void KAutostart::removeFromAllowedEnvironments ( const QString &  environment  ) 

Removes an environment to the list of environments this service may start in.

See also:
addToAllowedEnvironments()

Definition at line 238 of file kautostart.cpp.

void KAutostart::removeFromExcludedEnvironments ( const QString &  environment  ) 

Removes an environment to the list of environments this service may not be autostarted in.

See also:
addToExcludedEnvironments()

Definition at line 275 of file kautostart.cpp.

void KAutostart::setAllowedEnvironments ( const QStringList &  environments  ) 

Sets the environments this service is allowed to start in.

See also:
allowedEnvironments(), addToAllowedEnvironments()

Definition at line 220 of file kautostart.cpp.

void KAutostart::setAutostarts ( bool  autostart  ) 

Sets the given exec to start automatically at login.

Parameters:
autostart will register with the autostart facility when true and deregister when false
See also:
autostarts()

Definition at line 77 of file kautostart.cpp.

void KAutostart::setCommand ( const QString &  command  ) 

Set the associated command for this autostart service.

See also:
command()

Definition at line 144 of file kautostart.cpp.

void KAutostart::setCommandToCheck ( const QString &  exec  ) 

Sets the executable to check for the existence of when autostarting this service.

See also:
commandToCheck()

Definition at line 169 of file kautostart.cpp.

void KAutostart::setExcludedEnvironments ( const QStringList &  environments  ) 

Sets the environments this service is not allowed to start in.

See also:
excludedEnvironments(), addToExcludedEnvironments()

Definition at line 257 of file kautostart.cpp.

void KAutostart::setStartPhase ( KAutostart::StartPhase  phase  ) 

Sets the service (by name) this service should be started after.

Note that this is KDE specific and may not work in other environments.

See also:
StartPhase, startPhase()

Definition at line 198 of file kautostart.cpp.

void KAutostart::setVisibleName ( const QString &  entryName  ) 

Sets the user-visible name for this autostart service.

See also:
visibleName()

Definition at line 154 of file kautostart.cpp.

QString KAutostart::startAfter (  )  const

Returns the name of another service that should be autostarted before this one (if that service would be autostarted).

For internal use only.

Since:
4.3

Definition at line 289 of file kautostart.cpp.

KAutostart::StartPhase KAutostart::startPhase (  )  const

Returns the autostart phase this service is started in.

Note that this is KDE specific and may not work in other environments.

See also:
StartPhase, setStartPhase()

Definition at line 193 of file kautostart.cpp.

QString KAutostart::visibleName (  )  const

Returns the user-visible name this autostart service is registered as.

See also:
setVisibleName(), setEntryName()

Definition at line 149 of file kautostart.cpp.


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

KDECore

Skip menu "KDECore"
  • 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
  • KPty
  • Kross
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.6.1
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