plasma/kactivitymanagerd/README.md

0001 # KActivities
0002
0003 Core components for the KDE Activity concept
0004
0005 ## Introduction
0006
0007 When a user is interacting with a computer, there are three main areas of
0008 contextual information that may affect the behaviour of the system: who the user
0009 is, where they are, and what they are doing.
0010
0011 *Activities* deal with the last one. An activity might be "developing a KDE
0012 application", "studying 19th century art", "composing music" or "watching funny
0013 videos". Each of these activites may involve multiple applications, and a single
0014 application may be used in multiple activities (for example, most activities are
0015 likely to involve using a web browser, but different activities will probably
0016 involve different websites).
0017
0018 KActivities provides the infrastructure needed to manage a user's activites,
0019 allowing them to switch between tasks, and for applications to update their
0020 state to match the user's current activity. This includes a daemon, a library
0021 for interacting with that daemon, and plugins for integration with other
0022 frameworks.
0023
0024 ## Usage
0025
0026 Most applications that wish to be activity-aware will want to use
0027 KActivities::Consumer to keep track of the user's current activity, and
0028 KActivities::ResourceInstance to notify the activity manager of resources the
0029 user has accessed (this is not necessary for resources accessed via KIO, as a
0030 plugin is provided to do that automatically).
0031
0032 The other classes available in the API are primarily intended for use by the
0033 workspace to allow the user to view and manage available activities.