Development/Tutorials/Solid/Device Actions - Revision history

Ervin at 13:55, 30 September 2011

2011-09-30T13:55:07Z

Ervin: moved Development/Tutorials/Solid Device Actions to Development/Tutorials/Solid/Device Actions: Make it easier for linking and sorting out the Solid section

2011-09-30T13:30:04Z

moved Development/Tutorials/Solid Device Actions to Development/Tutorials/Solid/Device Actions: Make it easier for linking and sorting out the Solid section

Murphi81: /* Anatomy of an action */ Fixed closing tag after .desktop file

2011-07-30T14:11:31Z

‎Anatomy of an action: Fixed closing tag after .desktop file

Neverendingo: Text replace - "`" to ""`


2011-06-29T20:37:24Z
Text replace - "<code ini>" to "<syntaxhighlight lang="ini">"

				
				
				
				
			
			← Older revision
			Revision as of 20:37, 29 June 2011
			
Line 10:
Line 10:
    
  An Action file is a desktop configuration file similar to the following one:   An Action file is a desktop configuration file similar to the following one:
− <code ini> + <syntaxhighlight lang="ini">
  [Desktop Entry]   [Desktop Entry]
  X-KDE-Solid-Predicate=OpticalDisc.availableContent & 'Audio'   X-KDE-Solid-Predicate=OpticalDisc.availableContent & 'Audio'



Aseigo: moved Development/Tutorials/Plasma/Device Notifier to Development/Tutorials/Solid Device Actions: This is actually a Solid thing, so move it there.
2010-09-15T22:07:21Z
moved Development/Tutorials/Plasma/Device Notifier to Development/Tutorials/Solid Device Actions: This is actually a Solid thing, so move it there.

			
			← Older revision
			Revision as of 22:07, 15 September 2010
			


Aseigo: /* Actions and devices */
2010-09-15T22:05:37Z
‎Actions and devices

				
				
				
				
			
			← Older revision
			Revision as of 22:05, 15 September 2010
			
Line 27:
Line 27:
    
  The '''Device Notifier''' gets the devices and their corresponding actions by interrogating the'''hotplug''' Plasma DataEngine.  The '''hotplug''' DataEngine gets the set of devices from '''Solid''' and the set of actions from the subdirectories {{path|./solid/actions}} relative to the application settings path in '''KDE'''.  The set of actions pertaining to each device is then obtained by evaluating the Solid Predicate specified in the action against the physical and logical properties of the device; if the predicate holds, the action is included.   The '''Device Notifier''' gets the devices and their corresponding actions by interrogating the'''hotplug''' Plasma DataEngine.  The '''hotplug''' DataEngine gets the set of devices from '''Solid''' and the set of actions from the subdirectories {{path|./solid/actions}} relative to the application settings path in '''KDE'''.  The set of actions pertaining to each device is then obtained by evaluating the Solid Predicate specified in the action against the physical and logical properties of the device; if the predicate holds, the action is included.
− This is, of course, not limited to Plasma Desktop: any KDE application can similarly query '''Solid''' for the same actions. + This is, of course, not limited to Plasma Desktop: any application can similarly query '''Solid''' for the same actions.
    
  == Action predicates ==   == Action predicates ==



Aseigo: /* Actions and devices */
2010-09-15T22:05:21Z
‎Actions and devices

				
				
				
				
			
			← Older revision
			Revision as of 22:05, 15 September 2010
			
Line 26:
Line 26:
  == Actions and devices ==   == Actions and devices ==
    
− The '''Device Notifier''' gets the devices and their corresponding actions by interrogating its data engine called '''hotplug'''.  The '''hotplug''' data engine gets the set of devices from '''Solid''' and the set of actions from the subdirectories {{path|./solid/actions}} relative to the application settings path in '''KDE'''.  The set of actions pertaining to each device is then obtained by evaluating the Solid Predicate specified in the action against the physical and logical properties of the device; if the predicate holds, the action is included. + The '''Device Notifier''' gets the devices and their corresponding actions by interrogating the'''hotplug''' Plasma DataEngine.  The '''hotplug''' DataEngine gets the set of devices from '''Solid''' and the set of actions from the subdirectories {{path|./solid/actions}} relative to the application settings path in '''KDE'''.  The set of actions pertaining to each device is then obtained by evaluating the Solid Predicate specified in the action against the physical and logical properties of the device; if the predicate holds, the action is included.
  + This is, of course, not limited to Plasma Desktop: any KDE application can similarly query '''Solid''' for the same actions.
    
  == Action predicates ==   == Action predicates ==



Aseigo: /* Introduction */
2010-09-15T22:03:12Z
‎Introduction

				
				
				
				
			
			← Older revision
			Revision as of 22:03, 15 September 2010
			
Line 1:
Line 1:
  == Introduction ==   == Introduction ==
    
− The '''Device Notifier''' is a plasmoid that is responsible for handling device events.  When new data device is inserted or detected by '''Solid''', it gets added to the Device Notifier menu.  Each device has a set of ''actions'' the user can perform on the device, depending on the device type and its contents.  For example, when the media is an audio CD, the Device Notifier offers you to play that CD using '''Amarok'''.  The default actions are not a part of '''Plasma'''; rather, each one is installed by the application that handles the action, and goes away when the application is removed. + When a new data device is inserted or detected by '''Solid''', the hardware awareness framework introduced in KDE Platform 4, it gets added to the Device Notifier (a Plasma widget that is responsible for handling device events), Places list and other relevant areas in the user interface.   
  +  
  + Each device has a set of related ''actions'' which the user can perform on the device, depending on the device type and its contents.  For example, when the media is an audio CD, the Device Notifier may offer to play that CD using '''Amarok'''.  The default actions are not a part of '''Plasma Desktop''', however; rather, each action is defined by a simple .desktop file that is installed by the application that handles the action (e.g. Amarok in our Audio CD example), and goes away when the application is removed.
    
  You can add your own actions and modify existing ones using the '''Device Actions''' system setting module; however, such changes are limited to the user that requests the change.  If you want to install a custom action along with your application, you have to dig a bit deeper.   You can add your own actions and modify existing ones using the '''Device Actions''' system setting module; however, such changes are limited to the user that requests the change.  If you want to install a custom action along with your application, you have to dig a bit deeper.



Yecril71pl: /* Installing actions */ where is above
2010-09-15T21:34:17Z
‎Installing actions:  where is above

				
				
				
				
			
			← Older revision
			Revision as of 21:34, 15 September 2010
			
Line 49:
Line 49:
    
  == Installing actions ==   == Installing actions ==
− You install system-wide actions in the directory where the '''hotplug''' data engine will look for them (see above).  The action is available immediately after installation. + You install system-wide actions in the directory where the '''hotplug''' data engine will look for them (see [[#Actions and devices|above]]).  The action is available immediately after installation.



Yecril71pl: /* Executing actions */ Installing
2010-09-15T21:33:03Z
‎Executing actions:  Installing

				
				
				
				
			
			← Older revision
			Revision as of 21:33, 15 September 2010
			
Line 47:
Line 47:
    
  So you are free to choose whatever command syntax your application supports.  Note, however, that the forms <TT >%d</TT > and <TT >%i</TT > are deprecated by the Free Desktop standard and may be discontinued.   So you are free to choose whatever command syntax your application supports.  Note, however, that the forms <TT >%d</TT > and <TT >%i</TT > are deprecated by the Free Desktop standard and may be discontinued.
  + 
  + == Installing actions ==
  + You install system-wide actions in the directory where the '''hotplug''' data engine will look for them (see above).  The action is available immediately after installation.

← Older revision		Revision as of 13:55, 30 September 2011
Line 53:		Line 53:
	== Installing actions ==		== Installing actions ==
	You install system-wide actions in the directory where the '''hotplug''' data engine will look for them (see [[#Actions and devices\|above]]). The action is available immediately after installation.		You install system-wide actions in the directory where the '''hotplug''' data engine will look for them (see [[#Actions and devices\|above]]). The action is available immediately after installation.
		+
		+	[[Category:Tutorial]]
		+	[[Category:C++]]
		+	[[Category:KDE4]]
		+	[[Category:Solid]]

@@ Line 22: / Line 22: @@
 Icon=amarok
 Exec=amarok --cdplay %f
-</code >
+</syntaxhighlight >
 == Actions and devices ==

← Older revision		Revision as of 21:34, 15 September 2010
Line 49:		Line 49:

	== Installing actions ==		== Installing actions ==
−	You install system-wide actions in the directory where the '''hotplug''' data engine will look for them (see above). The action is available immediately after installation.	+	You install system-wide actions in the directory where the '''hotplug''' data engine will look for them (see [[#Actions and devices\|above]]). The action is available immediately after installation.

← Older revision		Revision as of 21:33, 15 September 2010
Line 47:		Line 47:

	So you are free to choose whatever command syntax your application supports. Note, however, that the forms <TT >%d</TT > and <TT >%i</TT > are deprecated by the Free Desktop standard and may be discontinued.		So you are free to choose whatever command syntax your application supports. Note, however, that the forms <TT >%d</TT > and <TT >%i</TT > are deprecated by the Free Desktop standard and may be discontinued.
		+
		+	== Installing actions ==
		+	You install system-wide actions in the directory where the '''hotplug''' data engine will look for them (see above). The action is available immediately after installation.

Development/Tutorials/Solid/Device Actions - Revision history

Ervin at 13:55, 30 September 2011

Ervin: moved Development/Tutorials/Solid Device Actions to Development/Tutorials/Solid/Device Actions: Make it easier for linking and sorting out the Solid section

Murphi81: /* Anatomy of an action */ Fixed closing tag after .desktop file

Neverendingo: Text replace - "" to ""

Aseigo: moved Development/Tutorials/Plasma/Device Notifier to Development/Tutorials/Solid Device Actions: This is actually a Solid thing, so move it there.

Aseigo: /* Actions and devices */

Aseigo: /* Actions and devices */

Aseigo: /* Introduction */

Yecril71pl: /* Installing actions */ where is above

Yecril71pl: /* Executing actions */ Installing

Neverendingo: Text replace - "`" to ""`