Development/Tutorials/Introduction to Get Hot New Stuff - Revision history

Icwiener: /* Preparations */ bash -> make

2011-06-30T10:29:52Z

‎Preparations: bash -> make

Neverendingo: /* Uploads */

2011-06-29T19:03:50Z

‎Uploads

Neverendingo: /* Downloading Data */

2011-06-29T19:03:23Z

‎Downloading Data

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


2011-06-29T19:01:50Z
Text replace - "<code cpp>" to "<syntaxhighlight lang="cpp">"

				
				
				
				
			
			← Older revision
			Revision as of 19:01, 29 June 2011
			
Line 18:
Line 18:
  The header files are installed under {{path|$KDEDIR/include/knewstuff/}}, so in the relevant files, they're included with statements such as:   The header files are installed under {{path|$KDEDIR/include/knewstuff/}}, so in the relevant files, they're included with statements such as:
    
− <code cpp> + <syntaxhighlight lang="cpp">
  #include <knewstuff/downloaddialog.h>   #include <knewstuff/downloaddialog.h>
  </syntaxhighlight>   </syntaxhighlight>



Neverendingo: Text replace - "" to ""

2011-06-29T18:54:49Z
Text replace - "<code ini>" to "<syntaxhighlight lang="ini">"

				
				
				
				
			
			← Older revision
			Revision as of 18:54, 29 June 2011
			
Line 61:
Line 61:
  Similar to the provider list, the installation procedures are described in the application's configuration file. The default (if these entries are missing) is to just download the file to a temporary location, which is not useful in most of the cases. There are two entries: target location, and post-installation command. The target location can either be StandardResource, matching the KDE resource types, or TargetDir, matching an application directory under {{path|$KDEHOME/share/apps/appname}}. The post installation command can be a binary with '%f' as parameter (note the single quotes to prevent string format attacks), but it can as well be a DCOP call, so the application can directly work with the data.     Similar to the provider list, the installation procedures are described in the application's configuration file. The default (if these entries are missing) is to just download the file to a temporary location, which is not useful in most of the cases. There are two entries: target location, and post-installation command. The target location can either be StandardResource, matching the KDE resource types, or TargetDir, matching an application directory under {{path|$KDEHOME/share/apps/appname}}. The post installation command can be a binary with '%f' as parameter (note the single quotes to prevent string format attacks), but it can as well be a DCOP call, so the application can directly work with the data.  
    
− <code ini> + <syntaxhighlight lang="ini">
  [KNewStuff]   [KNewStuff]
  StandardResource=wallpaper   StandardResource=wallpaper
Line 89:
Line 89:
  This can be done by adding the following lines to the ''myapprc'' file (create the file if there was none):   This can be done by adding the following lines to the ''myapprc'' file (create the file if there was none):
    
− <code ini> + <syntaxhighlight lang="ini">
  [KNewStuff]   [KNewStuff]
  ProvidersUrl=http://where_my_xml_file_is/providers.xml   ProvidersUrl=http://where_my_xml_file_is/providers.xml



Neverendingo: Text replace - "" to ""

2011-06-29T18:53:46Z
Text replace - "<code>" to "<syntaxhighlight lang="bash">"

				
				
				
				
			
			← Older revision
			Revision as of 18:53, 29 June 2011
			
Line 11:
Line 11:
  The first steps are usually made in preparing the usage of KNewStuff. For this matter, the library must be available (a task which could be done using autoconf, but since it's part of kdelibs, we simply assume it's available with any recent KDE installation.) Authors of 3rd pary applications can ensure the availability as part of kdepim-libs in KDE 3.2 using the AC_KNEWSTUFF macro. It must also be included in the set of libraries against which the application is linked, so modifying the {{path|Makefile.am}} and reconfiguring the application are to be done.   The first steps are usually made in preparing the usage of KNewStuff. For this matter, the library must be available (a task which could be done using autoconf, but since it's part of kdelibs, we simply assume it's available with any recent KDE installation.) Authors of 3rd pary applications can ensure the availability as part of kdepim-libs in KDE 3.2 using the AC_KNEWSTUFF macro. It must also be included in the set of libraries against which the application is linked, so modifying the {{path|Makefile.am}} and reconfiguring the application are to be done.
    
− <code> + <syntaxhighlight lang="bash">
  bin_PROGRAMS = myapp   bin_PROGRAMS = myapp
  myapp_LDADD = $(LIB_KDECORE) ... -lknewstuff   myapp_LDADD = $(LIB_KDECORE) ... -lknewstuff
Line 53:
Line 53:
  The example above implicitely constructs an internal Engine object, retrieves the directory list, fetches the provider lists specified in the directory, and the entries in each of the provider lists, compares them to the data files previously installed, and displays them in the download dialog. This dialog in turn handles all the installation issues. Of course there is no magic involved, and for more control about the subtasks, the following is recommended:     The example above implicitely constructs an internal Engine object, retrieves the directory list, fetches the provider lists specified in the directory, and the entries in each of the provider lists, compares them to the data files previously installed, and displays them in the download dialog. This dialog in turn handles all the installation issues. Of course there is no magic involved, and for more control about the subtasks, the following is recommended:  
    
− <code> + <syntaxhighlight lang="bash">
  (to be precised)   (to be precised)
  </syntaxhighlight>   </syntaxhighlight>
Line 95:
Line 95:
    
  To install it in the proper location, just add the following line to the {{path|Makefile.am}}:   To install it in the proper location, just add the following line to the {{path|Makefile.am}}:
− <code> + <syntaxhighlight lang="bash">
  kde_conf_DATA = ''myapprc''   kde_conf_DATA = ''myapprc''
  </syntaxhighlight>   </syntaxhighlight>



Neverendingo: Text replace - "" to ""
2011-06-29T18:41:51Z
Text replace - "</code>" to "</syntaxhighlight>"

				
				
				
				
			
			← Older revision
			Revision as of 18:41, 29 June 2011
			
Line 14:
Line 14:
  bin_PROGRAMS = myapp   bin_PROGRAMS = myapp
  myapp_LDADD = $(LIB_KDECORE) ... -lknewstuff   myapp_LDADD = $(LIB_KDECORE) ... -lknewstuff
− </code> + </syntaxhighlight>
                             
  The header files are installed under {{path|$KDEDIR/include/knewstuff/}}, so in the relevant files, they're included with statements such as:   The header files are installed under {{path|$KDEDIR/include/knewstuff/}}, so in the relevant files, they're included with statements such as:
Line 20:
Line 20:
  <code cpp>   <code cpp>
  #include <knewstuff/downloaddialog.h>   #include <knewstuff/downloaddialog.h>
− </code> + </syntaxhighlight>
                             
  The following header files are provided by KNewStuff:   The following header files are provided by KNewStuff:
Line 46:
Line 46:
     KNewStuff::DownloadDialog::open("myapp/templates");      KNewStuff::DownloadDialog::open("myapp/templates");
  }   }
− </code> + </syntaxhighlight>
    
  This is all. If desired, more control can be exercised on the whole download process, as outlined below. For the beginning, the above is already fully functional, and should be used at first.     This is all. If desired, more control can be exercised on the whole download process, as outlined below. For the beginning, the above is already fully functional, and should be used at first.  
Line 55:
Line 55:
  <code>   <code>
  (to be precised)   (to be precised)
− </code> + </syntaxhighlight>
    
  == Installation ==   == Installation ==
Line 67:
Line 67:
    
  TargetDir=kamikaze   TargetDir=kamikaze
− </code> + </syntaxhighlight>
    
  == Uploads ==   == Uploads ==
Line 81:
Line 81:
  KNewStuffGeneric *ns = new KNewStuffGeneric("myapp/templates", this);   KNewStuffGeneric *ns = new KNewStuffGeneric("myapp/templates", this);
  ns->upload(file.name(), previewfile.name());   ns->upload(file.name(), previewfile.name());
− </code> + </syntaxhighlight>
    
  == Finding the provider ==   == Finding the provider ==
Line 92:
Line 92:
  [KNewStuff]   [KNewStuff]
  ProvidersUrl=http://where_my_xml_file_is/providers.xml   ProvidersUrl=http://where_my_xml_file_is/providers.xml
− </code> + </syntaxhighlight>
    
  To install it in the proper location, just add the following line to the {{path|Makefile.am}}:   To install it in the proper location, just add the following line to the {{path|Makefile.am}}:
  <code>   <code>
  kde_conf_DATA = ''myapprc''   kde_conf_DATA = ''myapprc''
− </code> + </syntaxhighlight>
    
  == Setting up a provider.xml file ==   == Setting up a provider.xml file ==
Line 111:
Line 111:
     <title>New stuff for MyApp!</title>      <title>New stuff for MyApp!</title>
  </provider>   </provider>
− </code> + </syntaxhighlight>
    
  == Conclusion ==   == Conclusion ==
    
  Sharing creativity should become a default property of modern desktops, and KDE once again leads the pack by providing both upload and download facilities. If enough applications of different areas make use of them, it helps users to be more productive and have more fun with their computer.   Sharing creativity should become a default property of modern desktops, and KDE once again leads the pack by providing both upload and download facilities. If enough applications of different areas make use of them, it helps users to be more productive and have more fun with their computer.



Neverendingo: Text replace - "" to ""

2011-06-29T18:38:01Z
Text replace - "<code xml>" to "<syntaxhighlight lang="xml">"

				
				
				
				
			
			← Older revision
			Revision as of 18:38, 29 June 2011
			
Line 105:
Line 105:
  Here it is a simple {{path|provider.xml}} file, with no upload URL specified:   Here it is a simple {{path|provider.xml}} file, with no upload URL specified:
    
− <code xml> + <syntaxhighlight lang="xml">
  <provider downloadurl="http://where_my_newstuff_are/knewstuff.xml"   <provider downloadurl="http://where_my_newstuff_are/knewstuff.xml"
             nouploadurl=""              nouploadurl=""



Frederik.gladhorn: /* Introduction */
2010-03-25T13:51:23Z
‎Introduction

				
				
				
				
			
			← Older revision
			Revision as of 13:51, 25 March 2010
			
Line 1:
Line 1:
  {{improve}}   {{improve}}
  {{KDE3}}     {{KDE3}}  
  + 
  + == KDE 4 ==
  + Please read the [[Development/Tutorials#Get_Hot_New_Stuff|KDE 4 tutorials]] about get hot new stuff, unless you really work on KDE 3 apps.
    
  == Introduction ==   == Introduction ==



Tampakrap at 20:28, 15 November 2009
2009-11-15T20:28:31Z


				
				
				
				
			
			← Older revision
			Revision as of 20:28, 15 November 2009
			
Line 38:
Line 38:
  Depending on the application, providing additional data can be accomplished using the 'File Import' dialog, 'Internet Level' menu item, or just an 'Update now' {{class|KAction}}. All of those have in common that they invoke a slot which will contain the actual {{class|KNewStuff}} calls.     Depending on the application, providing additional data can be accomplished using the 'File Import' dialog, 'Internet Level' menu item, or just an 'Update now' {{class|KAction}}. All of those have in common that they invoke a slot which will contain the actual {{class|KNewStuff}} calls.  
    
− <code cppqt3> + <code cpp-qt>
  void MyApp::slotDownload()   void MyApp::slotDownload()
  {   {
Line 70:
Line 70:
  The beginning of the upload process works similar to downloads. A MasterServer or ProvidersUrl is used to retrieve the provider list, and one of the providers is selected by the user. Only providers which allow uploads are taken into account. After this selection however, the differences begin. The user has to fill in the necessary information such as title, author name or version number into the upload dialog. Also, the payload and preview files have to be selected, this however will in most cases be the application's task.  In Kamikaze, the level file is pre-rendered to an invisible {{qt3|QCanvas}}, and the resulting graphics is minimized and automatically specified for the upload.  The upload will then happen using the protocol accepted by the provider, which in most cases will be anonymous FTP.   The beginning of the upload process works similar to downloads. A MasterServer or ProvidersUrl is used to retrieve the provider list, and one of the providers is selected by the user. Only providers which allow uploads are taken into account. After this selection however, the differences begin. The user has to fill in the necessary information such as title, author name or version number into the upload dialog. Also, the payload and preview files have to be selected, this however will in most cases be the application's task.  In Kamikaze, the level file is pre-rendered to an invisible {{qt3|QCanvas}}, and the resulting graphics is minimized and automatically specified for the upload.  The upload will then happen using the protocol accepted by the provider, which in most cases will be anonymous FTP.
    
− <code cppqt3> + <code cpp-qt>
  #include <knewstuff/knewstuffgeneric.h>   #include <knewstuff/knewstuffgeneric.h>
  #include <knewstuff/engine.h>   #include <knewstuff/engine.h>