Development/Tutorials/Plasma/PackageStructure - Revision history

Neverendingo: Text replace - "" to ""

2011-06-30T10:20:03Z

Text replace - "<syntaxhighlight lang="make">" to "<syntaxhighlight lang="cmake">"

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


2011-06-29T21:06:40Z
Text replace - "<code cmake>" to "<syntaxhighlight lang="make">"

				
				
				
				
			
			← Older revision
			Revision as of 21:06, 29 June 2011
			
Line 147:
Line 147:
  ==Build and Install==   ==Build and Install==
  the CMakeLists.txt file tells CMake how to build and install your project, add the following lines to this file to for this test project. Note that the name used in kde4_add_plugin must match the library name used in the .desktop file:   the CMakeLists.txt file tells CMake how to build and install your project, add the following lines to this file to for this test project. Note that the name used in kde4_add_plugin must match the library name used in the .desktop file:
− <code cmake> + <syntaxhighlight lang="make">
  set(testpackage_SRC testpackage.cpp)   set(testpackage_SRC testpackage.cpp)

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

2011-06-29T20:54:08Z

Text replace - "</code>" to "</syntaxhighlight>"

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


2011-06-29T20:39:35Z
Text replace - "<code bash>" to "<syntaxhighlight lang="bash">"

				
				
				
				
			
			← Older revision
			Revision as of 20:39, 29 June 2011
			
Line 5:
Line 5:
  ==plasmapkg==   ==plasmapkg==
  The plasmapkg command line tool is used to get information about Packages and install, remove or upgrade them. Run     The plasmapkg command line tool is used to get information about Packages and install, remove or upgrade them. Run  
− <code bash> + <syntaxhighlight lang="bash">
  plasmapkg --help   plasmapkg --help
  </code>   </code>



Neverendingo: Text replace - "" to ""

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

				
				
				
				
			
			← Older revision
			Revision as of 20:36, 29 June 2011
			
Line 15:
Line 15:
  Every PackageStructure needs a desktop file to tell plasma what package it's defining:   Every PackageStructure needs a desktop file to tell plasma what package it's defining:
  '''plasma-packagestructure-test.desktop'''   '''plasma-packagestructure-test.desktop'''
− <code ini> + <syntaxhighlight lang="ini">
  [Desktop Entry]   [Desktop Entry]
  Name=Test   Name=Test





Neverendingo: Text replace - "" to ""

2011-06-29T20:30:13Z
Text replace - "<code cppqt>" to "<syntaxhighlight lang="cpp-qt">"

				
				
				
				
			
			← Older revision
			Revision as of 20:30, 29 June 2011
			
Line 43:
Line 43:
  ===The Header File===   ===The Header File===
  '''testpackage.h'''   '''testpackage.h'''
− <code cppqt> + <syntaxhighlight lang="cpp-qt">
  #ifndef TESTPACKAGESTRUCTURE_H   #ifndef TESTPACKAGESTRUCTURE_H
  #define TESTPACKAGESTRUCTURE_H   #define TESTPACKAGESTRUCTURE_H
Line 69:
Line 69:
  ===The Main Code===   ===The Main Code===
  '''testpackage.cpp'''   '''testpackage.cpp'''
− <code cppqt> + <syntaxhighlight lang="cpp-qt">
  #include "testpackage.h"   #include "testpackage.h"
    
Line 111:
Line 111:
  ====Dynamic File Definition====   ====Dynamic File Definition====
  For simplicity's sake, in this Example we've added code/main.js as the only file definition for the primary script file. With this approach, the package will only js scripts. If you want to support a larger set of scripting languages or allow the main script file to be defined within the package's metadata file, then the PackageStructure subclass should reimplement the protect virtual method pathChanged, which is called whenever the path this PackageStructure is representing changes (including when first set), and set the extension of the script file, perhaps using code like this:   For simplicity's sake, in this Example we've added code/main.js as the only file definition for the primary script file. With this approach, the package will only js scripts. If you want to support a larger set of scripting languages or allow the main script file to be defined within the package's metadata file, then the PackageStructure subclass should reimplement the protect virtual method pathChanged, which is called whenever the path this PackageStructure is representing changes (including when first set), and set the extension of the script file, perhaps using code like this:
− <code cppqt> + <syntaxhighlight lang="cpp-qt">
  // get path to your installed packages   // get path to your installed packages
  void TestPackageStructure::pathChanged()   void TestPackageStructure::pathChanged()





Nicolas17: typo
2011-06-25T02:35:26Z
typo

				
				
				
				
			
			← Older revision
			Revision as of 02:35, 25 June 2011
			
Line 110:
Line 110:
    
  ====Dynamic File Definition====   ====Dynamic File Definition====
− For simplicity's sake, in this Example we've added code/main.js as the only file definition for the primary script file. With this approach, the package will only js scripts. If you want to support a larger set of scripting languages or allow the main script file to be defined within the package's metadata file, then the PackageStructure subclass should reimpliment the protect virtual method pathChanged, which is called whenever the path this PackageStructure is representing changes (including when first set), and set the extension of the script file, perhaps using code like this: + For simplicity's sake, in this Example we've added code/main.js as the only file definition for the primary script file. With this approach, the package will only js scripts. If you want to support a larger set of scripting languages or allow the main script file to be defined within the package's metadata file, then the PackageStructure subclass should reimplement the protect virtual method pathChanged, which is called whenever the path this PackageStructure is representing changes (including when first set), and set the extension of the script file, perhaps using code like this:
  <code cppqt>   <code cppqt>
  // get path to your installed packages   // get path to your installed packages
Line 146:
Line 146:
    
  ==Build and Install==   ==Build and Install==
− the CMakeLists.txt file tells cmake how to build and install your project, add the following lines to this file to for this test project. Note that the name used in kde4_add_plugin must match the library name used in the .desktop file: + the CMakeLists.txt file tells CMake how to build and install your project, add the following lines to this file to for this test project. Note that the name used in kde4_add_plugin must match the library name used in the .desktop file:
  <code cmake>   <code cmake>
  set(testpackage_SRC testpackage.cpp)   set(testpackage_SRC testpackage.cpp)





Nicolas17: /* Build and Install */ use correct syntax highlighting
2011-06-25T02:30:57Z
‎Build and Install:  use correct syntax highlighting

				
				
				
				
			
			← Older revision
			Revision as of 02:30, 25 June 2011
			
Line 147:
Line 147:
  ==Build and Install==   ==Build and Install==
  the CMakeLists.txt file tells cmake how to build and install your project, add the following lines to this file to for this test project. Note that the name used in kde4_add_plugin must match the library name used in the .desktop file:   the CMakeLists.txt file tells cmake how to build and install your project, add the following lines to this file to for this test project. Note that the name used in kde4_add_plugin must match the library name used in the .desktop file:
− <code bash> + <code cmake>
  set(testpackage_SRC testpackage.cpp)   set(testpackage_SRC testpackage.cpp)
    





Nicolas17: Remove 'Abstract' heading, make the text appear as intro paragraph instead
2011-06-25T02:30:31Z
Remove 'Abstract' heading, make the text appear as intro paragraph instead

				
				
				
				
			
			← Older revision
			Revision as of 02:30, 25 June 2011
			
Line 1:
Line 1:
− ==Abstract==  
  A Plasma Package is a set of files, usually shipped in a single compressed archive, that together provide one particular data or functionality addon, such as Plasmoid or a Wallpaper set. Packages may be defined for any kind of custom data (e.g. non-compiled) addons. Packages can be installed, removed, listed and updated.   A Plasma Package is a set of files, usually shipped in a single compressed archive, that together provide one particular data or functionality addon, such as Plasmoid or a Wallpaper set. Packages may be defined for any kind of custom data (e.g. non-compiled) addons. Packages can be installed, removed, listed and updated.
    





Nicolas17: /* The Main Code */ fix syntax error in sample code
2011-06-25T02:28:54Z
‎The Main Code:  fix syntax error in sample code

				
				
				
				
			
			← Older revision
			Revision as of 02:28, 25 June 2011
			
Line 88:
Line 88:
       Q_UNUSED(args)        Q_UNUSED(args)
       // tell plasma about your package's directory structure with addDirectoryDefinition        // tell plasma about your package's directory structure with addDirectoryDefinition
−      addDirectoryDefinition("images", QLatin1String("images"), i18n( Images") ); +      addDirectoryDefinition("images", QLatin1String("images"), i18n("Images") );
       // what does the directory contain?        // what does the directory contain?
       QStringList mimetypes;        QStringList mimetypes;

@@ Line 7: / Line 7: @@
 <syntaxhighlight lang="bash">
 plasmapkg --help
-</code>
+</syntaxhighlight>
 to get a list of available options. The most commonly used options are
 {{path|-i}} for installing and {{path|-r}} for removing a package.
@@ Line 33: / Line 33: @@
 X-Plasma-PackageFileFilter=*.test
 X-Plasma-PackageFileMimetypes=application/zip
-</code>
+</syntaxhighlight>
 The most important fields are:
 * Name, Comment and Type fields, which are required for all desktop files.
@@ Line 65: / Line 65: @@
 K_EXPORT_PLASMA_PACKAGESTRUCTURE(myproject_test, TestPackageStructure)
 #endif // TESTPACKAGE_H
-</code>
+</syntaxhighlight>
 ===The Main Code===
@@ Line 107: / Line 107: @@
      setServicePrefix(QLatin1String("plasma-test-"));
+}
-</code>
+</syntaxhighlight>
 ====Dynamic File Definition====
@@ Line 143: / Line 143: @@
+     }
+}
-</code>
+</syntaxhighlight>
 ==Build and Install==
@@ Line 154: / Line 154: @@
 install(TARGETS plasma_packagestructure_myproject_test DESTINATION ${PLUGIN_INSTALL_DIR})
 install(FILES plasma-packagestructure-myproject-test.desktop DESTINATION ${SERVICES_INSTALL_DIR})
-</code>
+</syntaxhighlight>

← Older revision		Revision as of 02:30, 25 June 2011
Line 1:		Line 1:
−	~~==Abstract==~~
	A Plasma Package is a set of files, usually shipped in a single compressed archive, that together provide one particular data or functionality addon, such as Plasmoid or a Wallpaper set. Packages may be defined for any kind of custom data (e.g. non-compiled) addons. Packages can be installed, removed, listed and updated.		A Plasma Package is a set of files, usually shipped in a single compressed archive, that together provide one particular data or functionality addon, such as Plasmoid or a Wallpaper set. Packages may be defined for any kind of custom data (e.g. non-compiled) addons. Packages can be installed, removed, listed and updated.