Development/Tutorials/Services/Introduction - Revision history

AnneW at 09:14, 14 July 2012

2012-07-14T09:14:19Z

Icwiener: Fix syntax highlighting.

2011-06-27T15:19:39Z

Fix syntax highlighting.

DBoosalis: Corrected arguments in KStandardDirs::locate()

2009-05-13T22:17:24Z

Corrected arguments in KStandardDirs::locate()

Tampakrap: type

2009-03-30T06:47:52Z

type

Tampakrap: kded and kbuildsycoca commands have a "4" at the end

2008-07-10T20:41:23Z

kded and kbuildsycoca commands have a "4" at the end

Tampakrap: Language navigation bar added

2007-11-19T15:39:10Z

Language navigation bar added

Travlr: fixed typo

2007-09-26T17:48:16Z

fixed typo

Travlr: fixed typo

2007-09-26T17:45:03Z

fixed typo

Travlr: fixed typo

2007-09-26T17:40:53Z

fixed typo

Travlr: fixed typo

2007-09-26T17:35:06Z

fixed typo

← Older revision		Revision as of 09:14, 14 July 2012
Line 1:		Line 1:
−	~~{{Template:I18n/Language Navigation Bar\|Development/Tutorials/Services/Introduction}}~~	+

	{{TutorialBrowser\|		{{TutorialBrowser\|

@@ Line 51: / Line 51: @@
 The first approach is the most straightforward and often looks something like this:
-<code cppqt>
+<syntaxhighlight lang="cpp-qt">
-QString pathToDesktopFile = KStandardDirs::locate("services",
+QString pathToDesktopFile = KStandardDirs::locate("services", "konqueror.desktop");
-                                                  "konqueror.desktop");
 KService service(pathToDesktopFile);
-</code>
+</syntaxhighlight>
 KService also provides ways to load services by name directly with the <tt>serviceBy*</tt> set of methods, of which the safest and most recommended is <tt>serviceByStorageId</tt>:
-<code cppqt>
+<syntaxhighlight lang="cpp-qt">
 KService::Ptr service = KService::serviceByStorageId("konqueror");
-</code>
+</syntaxhighlight>
 Note that it passed back a <tt>KService::Ptr</tt> rather than just a {{class|KService}}. A <tt>{{class|KService}}::Ptr</tt> looks, acts and behaves just like a regular pointer (<tt>{{class|KService}}*</tt>) but it is automatically memory managed. It is not necessary to manually delete <tt>KService::Ptr</tt>s, because they are reference counted.
@@ Line 69: / Line 68: @@
 At this point we now have access to all sorts of information on the service, which in this case is an application called <tt>konqueror</tt>. We can even launch the app using this service:
-<code cppqt>
+<syntaxhighlight lang="cpp-qt">
 if (service.isApplication()) {
      KUrl::List urls;
@@ Line 75: / Line 74: @@
      KRun::run(service, urls, 0);
+}
-</code>
+</syntaxhighlight>
 This would launch <tt>konqueror</tt> and cause it to open the KDE homepage.

@@ Line 52: / Line 52: @@
 <code cppqt>
-QString pathToDesktopFile = KStandardDirs::locate("apps",
+QString pathToDesktopFile = KStandardDirs::locate("services",
-                                                   "konqueror");
+                                                   "konqueror.desktop");
 KService service(pathToDesktopFile);
 </code>

@@ Line 43: / Line 43: @@
 == KService ==
-The {{class|KService}} class is at the center of the services system. It serves both an informational and a functional role. {{class|KService}} provides access to details on a given service such as whether it is an application, the name of the service, the associated icon (if any), etc. But it can also used to launch applications and load plugins from disk.
+The {{class|KService}} class is at the center of the services system. It serves both an informational and a functional role. {{class|KService}} provides access to details on a given service such as whether it is an application, the name of the service, the associated icon (if any), etc. But it can also be used to launch applications and load plugins from disk.
 A {{class|KService}} object can be obtained in one of three ways:

@@ Line 91: / Line 91: @@
 While the <tt>.desktop</tt> (file) method is very handy for users (and adding new entries), performance could be an issue because it is common to have thousands of these files describing various mimetypes, applications, plugins, screensavers, etc. Thus, the entries are put into a binary cache which is accessed via shared memory by all applications. The cache is known as the '''Sy'''stem '''Co'''nfiguration '''Ca'''che, or SyCoCa for short. Loading and locating {{class|KService}}s is done via this cache, transparently to the application.
-Whenever a new <tt>.desktop</tt> file is added, removed or altered, the cache is automatically updated by the {{path|kbuildsycoca}} application. You can force an update of the cache by running {{path|kbuildsycoca}} manually, though usually it is launched by {{path|kded}} automatically when needed. A full rebuild of the cache (versus a simple update) can be triggered by passing <tt>--noincremental</tt> to {{path|kbuildsycoca}}.
+Whenever a new <tt>.desktop</tt> file is added, removed or altered, the cache is automatically updated by the {{path|kbuildsycoca4}} application. You can force an update of the cache by running {{path|kbuildsycoca4}} manually, though usually it is launched by {{path|kded4}} automatically when needed. A full rebuild of the cache (versus a simple update) can be triggered by passing <tt>--noincremental</tt> to {{path|kbuildsycoca4}}.
 == Searching For Services ==
 The next tutorial is [[../Traders|Finding Services Using Trader Queries]]. We will look at how to find services using the KTrader query language and {{class|KServiceTypeTrader}} .

← Older revision		Revision as of 15:39, 19 November 2007
Line 1:		Line 1:
		+	{{Template:I18n/Language Navigation Bar\|Development/Tutorials/Services/Introduction}}
		+
	{{TutorialBrowser\|		{{TutorialBrowser\|

← Older revision		Revision as of 17:48, 26 September 2007
Line 93:		Line 93:
	== Searching For Services ==		== Searching For Services ==

−	~~Next we~~ will look at how to find services using the KTrader query language and {{class\|KServiceTypeTrader}} ~~in the next tutorial, [[../Traders\|Finding Services Using Trader Queries]]~~.	+	The next tutorial is [[../Traders\|Finding Services Using Trader Queries]]. We will look at how to find services using the KTrader query language and {{class\|KServiceTypeTrader}} .

@@ Line 87: / Line 87: @@
 == SyCoCa: The System Configuration Cache ==
-While the <tt>.desktop</tt> file method is very handy for users and adding new entries, performance could be an issue as it is common to have thousands of these files describing various mimetypes, applications, plugins, screensavers, etc. Thus the entries are put into a binary cache that is accessed via shared memory by all applications. The cache is known as the '''Sy'''stem '''Co'''nfiguration '''Ca'''che, or SyCoCa for short. Loading and locating {{class|KService}}s is done via this cache transparently to the application.
+While the <tt>.desktop</tt> (file) method is very handy for users (and adding new entries), performance could be an issue because it is common to have thousands of these files describing various mimetypes, applications, plugins, screensavers, etc. Thus, the entries are put into a binary cache which is accessed via shared memory by all applications. The cache is known as the '''Sy'''stem '''Co'''nfiguration '''Ca'''che, or SyCoCa for short. Loading and locating {{class|KService}}s is done via this cache, transparently to the application.
-Whenever a new <tt>.desktop</tt> file is added, removed or altered the cache is automatically updated by the {{path|kbuildsycoca}} application. You can force an update of the cache by running {{path|kbuildsycoca}} manually, though usually it is launched by {{path|kded}} automatically when needed. A full rebuild of the cache (versus a simple update) can be triggered by passing <tt>--noincremental</tt> to {{path|kbuildsycoca}}.
+Whenever a new <tt>.desktop</tt> file is added, removed or altered, the cache is automatically updated by the {{path|kbuildsycoca}} application. You can force an update of the cache by running {{path|kbuildsycoca}} manually, though usually it is launched by {{path|kded}} automatically when needed. A full rebuild of the cache (versus a simple update) can be triggered by passing <tt>--noincremental</tt> to {{path|kbuildsycoca}}.
 == Searching For Services ==
 Next we will look at how to find services using the KTrader query language and {{class|KServiceTypeTrader}} in the next tutorial, [[../Traders|Finding Services Using Trader Queries]].

@@ Line 79: / Line 79: @@
 == Registering Services ==
-Services are represented on disk as individual <tt>.desktop</tt> files. This makes it easy to add, remove and customize services on the system. <tt>.desktop</tt> file is put depends on the type of service. Applications, plugins, protocols and mimetypes are each kept in their own directories. The location of these directories is documented in the [[KDE System Administration/KDE_Filesystem_Hierarchy|KDE Filesystem Hierarchy]] page. Installation is usually automated through the build system, such as CMake in KDE4.
+Services are represented on disk as individual <tt>.desktop</tt> files. This makes it easy to add, remove, and customize services on the system. The <tt>.desktop</tt> files are organized by their type of service. Applications, plugins, protocols, and mimetypes are each kept in their own directories. The location of these directories is documented in the [[KDE System Administration/KDE_Filesystem_Hierarchy|KDE Filesystem Hierarchy]] page. Installation is usually automated through the build system, such as CMake in KDE4.
 Services may also have one or more "service types" that are used to categorize and search for them. While applications and mimetypes don't utilize this, plugins and other services do. These service types are registered by placing a <tt>.desktop</tt> file describing the service type in the correct location in the filesystem, usually {{path|share/kde4/servicetypes}}. See the [[KDE System Administration/KDE_Filesystem_Hierarchy|KDE Filesystem Hierarchy]] page for more information.

@@ Line 55: / Line 55: @@
 </code>
-KService also provides ways to load services by name directly with the <tt>serviceBy*</tt> set of methods, of which the safest and most recommended on is <tt>serviceByStorageId</tt>:
+KService also provides ways to load services by name directly with the <tt>serviceBy*</tt> set of methods, of which the safest and most recommended is <tt>serviceByStorageId</tt>:
 <code cppqt>
@@ Line 61: / Line 61: @@
 </code>
-Note that it passed back a <tt>KService::Ptr</tt> rather than just a {{class|KService}}. A <tt>{{class|KService}}::Ptr</tt> looks, acts and behaves just like a regular pointer (<tt>{{class|KService}}*</tt>) but it is automatically memory managed. It is not necessary to manually delete <tt>KService::Ptr</tt>s as they are reference counted.
+Note that it passed back a <tt>KService::Ptr</tt> rather than just a {{class|KService}}. A <tt>{{class|KService}}::Ptr</tt> looks, acts and behaves just like a regular pointer (<tt>{{class|KService}}*</tt>) but it is automatically memory managed. It is not necessary to manually delete <tt>KService::Ptr</tt>s, because they are reference counted.
 A list of all services can be retrieved using the <tt>{{class|KService}}::allServices</tt> method. Of course, one often wants finer grained control over locating services, which is the role of the {{class|KServiceTypeTrader}} and is the topic of the next tutorial in this series.