Development/Tutorials/Plasma/ComicPlugin - Revision history

Marlon: /* date-functions */ changed link to docs for QT's QDate

2013-01-02T20:09:25Z

‎date-functions: changed link to docs for QT's QDate

Marlon: /* date-functions */ changed links to sourcecode for the comicproviderwrapper

2013-01-02T20:05:27Z

‎date-functions: changed links to sourcecode for the comicproviderwrapper

Marlon: /* date-functions */ Striked links to source code since they dont work

2013-01-02T19:50:55Z

‎date-functions: Striked links to source code since they dont work

AnneW at 18:38, 15 July 2012

2012-07-15T18:38:11Z

Neverendingo: Text replace - "" to ""

2011-06-29T20:53:29Z

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

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


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

				
				
				
				
			
			← Older revision
			Revision as of 20:36, 29 June 2011
			
Line 49:
Line 49:
  Every comic plugin needs a metadata.desktop file like the following:   Every comic plugin needs a metadata.desktop file like the following:
    
− <code ini> + <syntaxhighlight lang="ini">
  [Desktop Entry]   [Desktop Entry]
  Name=My Comic   Name=My Comic
Line 72:
Line 72:
  languages e.g.   languages e.g.
    
− <code ini> + <syntaxhighlight lang="ini">
  Name[de]=Mein Comic   Name[de]=Mein Comic
  Comment[de]=Mein Comic   Comment[de]=Mein Comic



Neverendingo: Text replace - "" to ""

2011-06-29T20:35:38Z
Text replace - "<code javascript>" to "<syntaxhighlight lang="javascript">"
Show changes


PhreakOnALeash: fix missing markup
2011-01-05T07:41:34Z
fix missing markup

				
				
				
				
			
			← Older revision
			Revision as of 07:41, 5 January 2011
			
Line 423:
Line 423:
     }      }
  }   }
  + </code>
    
  ===Examples===   ===Examples===



Mat69: Adds information on the image objective
2010-07-04T11:08:12Z
Adds information on the image objective

				
				
				
				
			
			← Older revision
			Revision as of 11:08, 4 July 2010
			
Line 405:
Line 405:
  print(comic.identifier);            //would be "muahaha" now   print(comic.identifier);            //would be "muahaha" now
  </code>   </code>
  + 
  + ====comic.image()====
  + Accesses the image object.
  + 
  + Following is an example that works with apiVersion 4600. It sets the last frame of an animation as used image. In fact before this can work data has to be set e.g. via ''comic.requestPage(url, comic.Image)''.
  + 
  + <code javascript>
  + var img = comic.image();
  + if (comic.apiVersion >= 4600) {
  +   var count = img.imageCount();//The number of frames if it is an anmiation, otherwise 0 or -1 if there was an error
  +   if (count >= 0) {
  +     var temp;
  +     for (i = 0; i < count; i++) {
  +       temp = img.read();//reads the next frame and stores it in temp
  +     }
  +     img.image = temp;//sets the last frame as image
  +   }
  + }
    
  ===Examples===   ===Examples===



Mat69 at 10:38, 4 July 2010
2010-07-04T10:38:59Z


				
				
				
				
			
			← Older revision
			Revision as of 10:38, 4 July 2010
			
Line 127:
Line 127:
    
  What data is depends on the id.   What data is depends on the id.
− If the id is ''comic.image'' then ''data'' is the image, making any changes to data will change the image being displayed by the comic plugin. In all other cases''data'' is the downloaded data in a byte stream converted to unicode -- in some cases not see comic.textCodec at [Available Objects] -- while ''id'' defines what kind of download it was. You can convert the byte stream to a String if ''needed'': + If the id is ''comic.Image'' then ''data'' is the image, making any changes to data will change the image being displayed by the comic plugin. In all other cases ''data'' is the downloaded data in a byte stream converted to unicode -- in some cases not see comic.textCodec at [Available Objects] -- while ''id'' defines what kind of download it was. You can convert the byte stream to a String if ''needed'':
  <code javascript>   <code javascript>
  var dataString = data.toString();   var dataString = data.toString();

@@ Line 203: / Line 203: @@
 ====date-functions====
-Here I'm showing only two examples of the date-object and its member functions. If you want more information look at the sourcecode of [https://projects.kde.org/projects/kde/kdeplasma-addons/repository/revisions/master/entry/dataengines/comic/comicproviderwrapper.h comicproviderwrapper.h], [https://projects.kde.org/projects/kde/kdeplasma-addons/repository/revisions/master/entry/dataengines/comic/comicproviderwrapper.cpp comicproviderwrapper.cpp] and look at the <strike>[http://doc.trolltech.com/4.4/qdate.html Qt-documentation]</strike> as this object was designed to work similar to QDate. In some cases there might be differences though!
+Here I'm showing only two examples of the date-object and its member functions. If you want more information look at the sourcecode of [https://projects.kde.org/projects/kde/kdeplasma-addons/repository/revisions/master/entry/dataengines/comic/comicproviderwrapper.h comicproviderwrapper.h], [https://projects.kde.org/projects/kde/kdeplasma-addons/repository/revisions/master/entry/dataengines/comic/comicproviderwrapper.cpp comicproviderwrapper.cpp] and look at the [http://qt-project.org/doc/qt-5.0/qtcore/qdate.html Qt-documentation] as this object was designed to work similar to QDate. In some cases there might be differences though!
 <syntaxhighlight lang="javascript">

@@ Line 203: / Line 203: @@
 ====date-functions====
-Here I'm showing only two examples of the date-object and its member functions. If you want more information look at the sourcecode of <strike> [http://websvn.kde.org:80/trunk/KDE/kdeplasma-addons/dataengines/comic/comicproviderwrapper.h?view=markup comicproviderwrapper.h], [http://websvn.kde.org:80/trunk/KDE/kdeplasma-addons/dataengines/comic/comicproviderwrapper.cpp?view=markup comicproviderwrapper.cpp]</strike> and look at the <strike>[http://doc.trolltech.com/4.4/qdate.html Qt-documentation]</strike> as this object was designed to work similar to QDate. In some cases there might be differences though!
+Here I'm showing only two examples of the date-object and its member functions. If you want more information look at the sourcecode of [https://projects.kde.org/projects/kde/kdeplasma-addons/repository/revisions/master/entry/dataengines/comic/comicproviderwrapper.h comicproviderwrapper.h], [https://projects.kde.org/projects/kde/kdeplasma-addons/repository/revisions/master/entry/dataengines/comic/comicproviderwrapper.cpp comicproviderwrapper.cpp] and look at the <strike>[http://doc.trolltech.com/4.4/qdate.html Qt-documentation]</strike> as this object was designed to work similar to QDate. In some cases there might be differences though!
 <syntaxhighlight lang="javascript">

@@ Line 203: / Line 203: @@
 ====date-functions====
-Here I'm showing only two examples of the date-object and its member functions. If you want more information look at the sourcecode of [http://websvn.kde.org:80/trunk/KDE/kdeplasma-addons/dataengines/comic/comicproviderwrapper.h?view=markup comicproviderwrapper.h], [http://websvn.kde.org:80/trunk/KDE/kdeplasma-addons/dataengines/comic/comicproviderwrapper.cpp?view=markup comicproviderwrapper.cpp] and look at the [http://doc.trolltech.com/4.4/qdate.html Qt-documentation] as this object was designed to work similar to QDate. In some cases there might be differences though!
+Here I'm showing only two examples of the date-object and its member functions. If you want more information look at the sourcecode of <strike> [http://websvn.kde.org:80/trunk/KDE/kdeplasma-addons/dataengines/comic/comicproviderwrapper.h?view=markup comicproviderwrapper.h], [http://websvn.kde.org:80/trunk/KDE/kdeplasma-addons/dataengines/comic/comicproviderwrapper.cpp?view=markup comicproviderwrapper.cpp]</strike> and look at the <strike>[http://doc.trolltech.com/4.4/qdate.html Qt-documentation]</strike> as this object was designed to work similar to QDate. In some cases there might be differences though!
 <syntaxhighlight lang="javascript">

← Older revision		Revision as of 18:38, 15 July 2012
Line 1:		Line 1:
−	~~{{Template:I18n/Language Navigation Bar\|Development/Tutorials/Plasma/ComicPlugin}}~~

	==Abstract==		==Abstract==

@@ Line 66: / Line 66: @@
 X-KDE-PluginInfo-EnabledByDefault=true
 X-KDE-PlasmaComicProvider-SuffixType=Date
-</code>
+</syntaxhighlight>
 In the "Name" and "Comment" section add the name of the comic you want to add.
 It will show up in the comic list (that is not the "Get New Comics..."-dialog)
@@ Line 75: / Line 75: @@
 Name[de]=Mein Comic
 Comment[de]=Mein Comic
-</code>
+</syntaxhighlight>
 You only need "Icon" if you have an icon for your comic -- like a favicon. In this example, the file is called "icon.png".
@@ Line 95: / Line 95: @@
 function pageRetrieved(id, data, metadata)
 comic.combine(image, position)
-</code>
+</syntaxhighlight>
 Additionally to that there are some date-handling functions similar to [http://doc.trolltech.com/4.4/qdate.html QDate].
@@ Line 119: / Line 119: @@
 comic.requestPage( "www.example.com/image.jpg", comic.image, info );
 comic.requestPage( "www.example.com/image.jpg", comic.image ); //would also work, but send no metadata
-</code>
+</syntaxhighlight>
 If the download was successful the dataengine will call pageRetrieved.
@@ Line 131: / Line 131: @@
 var dataString = data.toString();
 var begin = dataString.indexOf( "test" ); //would not work without the conversion
-</code>
+</syntaxhighlight>
 Here you could search in the data for the URL to the comic strip, the title of the comic, the comic's author, the identifier for the next comic, etc.
@@ Line 199: / Line 199: @@
+     }
+}
-</code>
+</syntaxhighlight>
 Another comic plugin that currently uses this feature is [http://www.kde-files.org/content/show.php/Shit+Happens!+(de)?content=92045 Shit Happens!], though in this case an image provided by the comic-package is combined with the comics.
@@ Line 209: / Line 209: @@
 comic.identifier = date.fromString("2008,03,07", "yyyy,MM,dd");
 comic.website += comic.identifier.toString("dd-MM-yyyy");
-</code>
+</syntaxhighlight>
 ====comic.requestRedirectedUrl(url, id, metadata)====
@@ Line 244: / Line 244: @@
+   }
+}
-</code>
+</syntaxhighlight>
 ====redirected(id, url)====
@@ Line 266: / Line 266: @@
 comic.isLeftToRight = false;               //true is the default, only set if the comic is not LTR (introduced with 4.3)
 comic.isTopToBottom = false;               //true is the default, only set if the comic is not from TopToBottom (introduced with 4.3)
-</code>
+</syntaxhighlight>
 Refer the Qt documentation for a [http://doc.trolltech.com/4.4/qtextcodec.html#details list of codecs you can use in comic.textCodec].
@@ Line 285: / Line 285: @@
    //... do something
+}
-</code>
+</syntaxhighlight>
@@ Line 298: / Line 298: @@
 comic.nextIdentifier      //the next identifier of the current strip e.g. 41
 comic.identifierSpecified //if the caller of the dataEngine specified an (bool) identifier
-</code>
+</syntaxhighlight>
 '''comic.identifier''' is the identifier the dataengine is being asked for, so it is already set, though you can assign something different to it if needed.
@@ Line 314: / Line 314: @@
 comic.firstIdentifier   //has to be manually specified
 comic.lastIdentifier    //is today by default
-</code>
+</syntaxhighlight>
 If you are assigning something to comic.lastIdentifier, then comic.identifier will be reassigned that day automatically, but only if comic.identifier was a day after comic.lastIdentifier, or if comic.identifierSpecified is false e.g.:
@@ Line 326: / Line 326: @@
 comic.lastIdentifier = date.fromString("2009-02-01");
 print(comic.identifier);    //still 2009-01-10
-</code>
+</syntaxhighlight>
 In any case comic.identifier will be in the specified range you defined.
@@ Line 353: / Line 353: @@
 comic.firstIdentifier   //is 1 by default
 comic.lastIdentifier    //has to be manually specified
-</code>
+</syntaxhighlight>
 Note: The following part is for 4.2 only
@@ Line 367: / Line 367: @@
 comic.lastIdentifier = 100;
 print(comic.identifier);    //still 42
-</code>
+</syntaxhighlight>
 Note: This part is 4.2.1+
@@ Line 375: / Line 375: @@
 comic.lastIdentifier = 20;
 print(comic.identifier);            //would be 20 now
-</code>
+</syntaxhighlight>
 In any case comic.identifier will be in the specified range.
@@ Line 404: / Line 404: @@
 comic.lastIdentifier = "muahaha";
 print(comic.identifier);            //would be "muahaha" now
-</code>
+</syntaxhighlight>
 ====comic.image()====
@@ Line 423: / Line 423: @@
+   }
+}
-</code>
+</syntaxhighlight>
 ===Examples===
@@ Line 534: / Line 534: @@
+     }
+}
-</code>
+</syntaxhighlight>
 ====number====
@@ Line 600: / Line 600: @@
+     }
+}
-</code>
+</syntaxhighlight>
 ====string====
@@ Line 691: / Line 691: @@
+     }
+}
-</code>
+</syntaxhighlight>
 ==Testing the plugin==
@@ Line 754: / Line 754: @@
+     }
+}
-</code>
+</syntaxhighlight>
 I add "****" in the print to find the output more easily.
@@ Line 762: / Line 762: @@
 <syntaxhighlight lang="javascript">
 print(data);
-</code>
+</syntaxhighlight>
 so that you can check if the data is correct and if it is what you expected.