Development/Tutorials/KDE2/Extending the KDE Panel - Revision history

Neverendingo: Text replace - "" to ""

2011-06-29T20:52:00Z

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

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


2011-06-29T20:44:53Z
Text replace - "<code>" to "<syntaxhighlight lang="text">"

				
				
				
				
			
			← Older revision
			Revision as of 20:44, 29 June 2011
			
Line 122:
Line 122:
    
  === The automake input file: Makefile.am ===   === The automake input file: Makefile.am ===
− <code> + <syntaxhighlight lang="text">
  INCLUDES = $(all_includes)     INCLUDES = $(all_includes)  
    
Line 151:
Line 151:
  === Building and installing ===   === Building and installing ===
  You can download a complete helloworldapplet.tar.gz tarball here: [http://developer.kde.org/documentation/tutorials/dot/khelloworldapplet.tar.gz khelloworldapplet.tar.gz] (308 kB), which in addition to the four files mentioned above contains the automake/autoconf magic of the KDE build system. It's convenient to base your own panel applets on as the build system magic is already in place. Untar it, change into the untarred directory and build and install it with:   You can download a complete helloworldapplet.tar.gz tarball here: [http://developer.kde.org/documentation/tutorials/dot/khelloworldapplet.tar.gz khelloworldapplet.tar.gz] (308 kB), which in addition to the four files mentioned above contains the automake/autoconf magic of the KDE build system. It's convenient to base your own panel applets on as the build system magic is already in place. Untar it, change into the untarred directory and build and install it with:
− <code> + <syntaxhighlight lang="text">
  ./configure -prefix=<your-kde-dir>     ./configure -prefix=<your-kde-dir>  
  make   make



Neverendingo: Text replace - "" to ""

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

				
				
				
				
			
			← Older revision
			Revision as of 20:36, 29 June 2011
			
Line 93:
Line 93:
    
  === The description file: helloworldapplet.desktop ===   === The description file: helloworldapplet.desktop ===
− <code ini> + <syntaxhighlight lang="ini">
  [Desktop Entry]     [Desktop Entry]  
  Name = Hello World   Name = Hello World



Neverendingo: Text replace - "" to ""

2011-06-29T20:32:10Z
Text replace - "<code cppqt n>" to "<syntaxhighlight lang="cpp-qt" line>"

				
				
				
				
			
			← Older revision
			Revision as of 20:32, 29 June 2011
			
Line 23:
Line 23:
    
  === HelloWorldApplet class declaration ===   === HelloWorldApplet class declaration ===
− <code cppqt n> + <syntaxhighlight lang="cpp-qt" line>
  class HelloWorldApplet : public KPanelApplet   class HelloWorldApplet : public KPanelApplet
  {   {
Line 48:
Line 48:
    
  === HelloWorldApplet class implementation ===   === HelloWorldApplet class implementation ===
− <code cppqt n> + <syntaxhighlight lang="cpp-qt" line>
  HelloWorldApplet::HelloWorldApplet( const QString& configFile,   HelloWorldApplet::HelloWorldApplet( const QString& configFile,
                                     Type type, int actions,                                      Type type, int actions,
Line 77:
Line 77:
    
  === The factory function ===   === The factory function ===
− <code cppqt n> + <syntaxhighlight lang="cpp-qt" line>
  extern "C"     extern "C"  
  {   {
Line 166:
Line 166:
    
  {{path|fifteenapplet.h}} contains the declaration of FifteenApplet, the class inheriting from KPanelApplet :   {{path|fifteenapplet.h}} contains the declaration of FifteenApplet, the class inheriting from KPanelApplet :
− <code cppqt n> + <syntaxhighlight lang="cpp-qt" line>
  class FifteenApplet : public KPanelApplet     class FifteenApplet : public KPanelApplet  
  {   {
Line 195:
Line 195:
    
  The second class declared in {{path|fifteenapplet.h}} is our game board inheriting from QTableView :   The second class declared in {{path|fifteenapplet.h}} is our game board inheriting from QTableView :
− <code cppqt n> + <syntaxhighlight lang="cpp-qt" line>
  class PiecesTable : public QTableView     class PiecesTable : public QTableView  
  {   {
Line 241:
Line 241:
    
  The factory function is very similar to the one of the helloworld applet with all occurrences of "helloworldapplet" replaced with "fifteenapplet". The second difference you might notice is that we pass KPanelApplet::About as the third parameter of the FifteenApplet constructor to make sure the "About" context menu entry will be there:   The factory function is very similar to the one of the helloworld applet with all occurrences of "helloworldapplet" replaced with "fifteenapplet". The second difference you might notice is that we pass KPanelApplet::About as the third parameter of the FifteenApplet constructor to make sure the "About" context menu entry will be there:
− <code cppqt n> + <syntaxhighlight lang="cpp-qt" line>
  extern "C"     extern "C"  
  {   {
Line 254:
Line 254:
  </code>   </code>
  The implementation of the FifteenApplet class is very short as the game board class will handle all the drawing and game logic.   The implementation of the FifteenApplet class is very short as the game board class will handle all the drawing and game logic.
− <code cppqt n> + <syntaxhighlight lang="cpp-qt" line>
  FifteenApplet::FifteenApplet(const QString& configFile, Type type, int actions,   FifteenApplet::FifteenApplet(const QString& configFile, Type type, int actions,
                              QWidget *parent, const char *name)                               QWidget *parent, const char *name)
Line 274:
Line 274:
  </code>   </code>
  The constructor creates an instance of our game board class and places it into a simple layout object to resize it to the full applet size every time the applet itself is resized. srandom is used to initialize the random number generator with the current time in seconds (see the man pages of srandom and random) as seed.   The constructor creates an instance of our game board class and places it into a simple layout object to resize it to the full applet size every time the applet itself is resized. srandom is used to initialize the random number generator with the current time in seconds (see the man pages of srandom and random) as seed.
− <code cppqt n> + <syntaxhighlight lang="cpp-qt" line>
  int FifteenApplet::widthForHeight(int h) const     int FifteenApplet::widthForHeight(int h) const  
  {   {
Line 286:
Line 286:
  </code>   </code>
  Similar to the hello world applet the fifteen pieces applet will have a quadratic shape.   Similar to the hello world applet the fifteen pieces applet will have a quadratic shape.
− <code cppqt n> + <syntaxhighlight lang="cpp-qt" line>
  void FifteenApplet::about()     void FifteenApplet::about()  
  {   {
Line 311:
Line 311:
    
  Now let's have a look at the implementation of the game board class called PiecesTable As it inherits from QTableView you might want to have a look at the description of this abstract base class for tables in the excellent Qt documentation:  [http://doc.trolltech.com/qtableview.html#details http://doc.trolltech.com/qtableview.html#details]   Now let's have a look at the implementation of the game board class called PiecesTable As it inherits from QTableView you might want to have a look at the description of this abstract base class for tables in the excellent Qt documentation:  [http://doc.trolltech.com/qtableview.html#details http://doc.trolltech.com/qtableview.html#details]
− <code cppqt n> + <syntaxhighlight lang="cpp-qt" line>
  PiecesTable::PiecesTable(QWidget* parent, const char* name )   PiecesTable::PiecesTable(QWidget* parent, const char* name )
     : QTableView(parent, name), _menu(0), _activeRow(-1),        : QTableView(parent, name), _menu(0), _activeRow(-1),  
Line 337:
Line 337:
  </code>   </code>
  The constructor initializes a few member variables used by the game board, sets up the frame style of the table ( QTableView inherits from QFrame ), sets the background mode to NoBackground (we do this to avoid flicker), enables mouse tracking for the widget and configures the number of rows and columns of the table. We also call two protected initialization functions we have defined in PiecesTable to set up two arrays, one (array of ints) used to represent the game board and another (array of QColor ) where we store color values for the 15 pieces.   The constructor initializes a few member variables used by the game board, sets up the frame style of the table ( QTableView inherits from QFrame ), sets the background mode to NoBackground (we do this to avoid flicker), enables mouse tracking for the widget and configures the number of rows and columns of the table. We also call two protected initialization functions we have defined in PiecesTable to set up two arrays, one (array of ints) used to represent the game board and another (array of QColor ) where we store color values for the 15 pieces.
− <code cppqt n> + <syntaxhighlight lang="cpp-qt" line>
  void PiecesTable::initMap()     void PiecesTable::initMap()  
  {   {
Line 349:
Line 349:
  </code>   </code>
  initMap() resizes the QArray<int> we use to represent the game board to 16 (4x4 fields on the board) and initializes it with the values one to fifteen.   initMap() resizes the QArray<int> we use to represent the game board to 16 (4x4 fields on the board) and initializes it with the values one to fifteen.
− <code cppqt n> + <syntaxhighlight lang="cpp-qt" line>
  void PiecesTable::initColors()     void PiecesTable::initColors()  
  {   {
Line 360:
Line 360:
  </code>   </code>
  initColors() is similar but calculates different color values for each piece to increase the eye candy effect of our applet.   initColors() is similar but calculates different color values for each piece to increase the eye candy effect of our applet.
− <code cppqt n> + <syntaxhighlight lang="cpp-qt" line>
  void PiecesTable::paintCell(QPainter *p, int row, int col)   void PiecesTable::paintCell(QPainter *p, int row, int col)
  {   {
Line 418:
Line 418:
  </code>   </code>
  We have reimplemented void paintCell() from QTableView to actually paint the table cells, which on our game board represent sliding pieces, when the widgets receives a paint event. The function is a bit to long to explain in all detail but is quite easy to understand looking up calls you are unsure about in the Qt documentation for {{qt2|QPainter}} and {{qt2|QTableView}}   We have reimplemented void paintCell() from QTableView to actually paint the table cells, which on our game board represent sliding pieces, when the widgets receives a paint event. The function is a bit to long to explain in all detail but is quite easy to understand looking up calls you are unsure about in the Qt documentation for {{qt2|QPainter}} and {{qt2|QTableView}}
− <code cppqt n> + <syntaxhighlight lang="cpp-qt" line>
  void PiecesTable::resizeEvent(QResizeEvent *e)     void PiecesTable::resizeEvent(QResizeEvent *e)  
  {   {
Line 450:
Line 450:
    
  For some extra eye candy we reimplement the mouseMoveEvent() action handler of the game board widget to highlight the cell (piece) under the mouse cursor if the mouse is moved over the board:   For some extra eye candy we reimplement the mouseMoveEvent() action handler of the game board widget to highlight the cell (piece) under the mouse cursor if the mouse is moved over the board:
− <code cppqt n> + <syntaxhighlight lang="cpp-qt" line>
  void PiecesTable::mouseMoveEvent(QMouseEvent* e)     void PiecesTable::mouseMoveEvent(QMouseEvent* e)  
  {   {
Line 489:
Line 489:
    
  As the idea of the game is to put randomized pieces in numerical order, we first implement a helper function used to randomize the arrangement of the pieces on the game board:   As the idea of the game is to put randomized pieces in numerical order, we first implement a helper function used to randomize the arrangement of the pieces on the game board:
− <code cppqt n> + <syntaxhighlight lang="cpp-qt" line>
  void PiecesTable::randomizeMap()     void PiecesTable::randomizeMap()  
  {   {
Line 517:
Line 517:
  </code>   </code>
  We need a second helper function to be called after each move operation to check whether the player won with the previous move and to display a message box in case of victory. You may have notice the _randomized member variable in the functions above and from the code in checkwin() you see that it is used to make sure that we trigger the "You win!" message box only if the player actually did randomize the game board before putting it into numerical order.   We need a second helper function to be called after each move operation to check whether the player won with the previous move and to display a message box in case of victory. You may have notice the _randomized member variable in the functions above and from the code in checkwin() you see that it is used to make sure that we trigger the "You win!" message box only if the player actually did randomize the game board before putting it into numerical order.
− <code cppqt n> + <syntaxhighlight lang="cpp-qt" line>
  void PiecesTable::checkwin()     void PiecesTable::checkwin()  
  {   {
Line 536:
Line 536:
  </code>   </code>
  Move operations are triggered by the player clicking on one of the sliding pieces. We reimplement the mousePressEvent() handler of the game board widgets to handle mouse clicks on the board. Right mouse button clicks trigger an additional context menu with actions to randomize or reset the game board. A left mouse button click triggers the game logic which is pretty simple if you take 5 minutes to think about it. You should be able to understand the details reading the numerous comments in the code:   Move operations are triggered by the player clicking on one of the sliding pieces. We reimplement the mousePressEvent() handler of the game board widgets to handle mouse clicks on the board. Right mouse button clicks trigger an additional context menu with actions to randomize or reset the game board. A left mouse button click triggers the game logic which is pretty simple if you take 5 minutes to think about it. You should be able to understand the details reading the numerous comments in the code:
− <code cppqt n> + <syntaxhighlight lang="cpp-qt" line>
  void PiecesTable::mousePressEvent(QMouseEvent* e)   void PiecesTable::mousePressEvent(QMouseEvent* e)
  {   {



Dhaumann: some fixes.  links still wrong

2007-07-11T20:24:42Z
some fixes. <code cppqt> links still wrong

				
				
				
				
			
			← Older revision
			Revision as of 20:24, 11 July 2007
			
Line 6:
Line 6:
  Panel applets are small applications living inside the panel. Available applets range from desktop pagers and task bars to little games or other toys. In contrast to applets the panel extension API is an interface for extensions living outside of the panel, in the window manager dock area (as defined in the  [http://www.freedesktop.org/standards/wm-spec.html freedesktop.org window manager specifications] and are managed by the panel. Examples for panel extensions are the external task bar and the dock application bar which adds support for [http://www.windowmaker.org Window Maker] applets and other applications using the standard X11 docking mechanism to kicker.   Panel applets are small applications living inside the panel. Available applets range from desktop pagers and task bars to little games or other toys. In contrast to applets the panel extension API is an interface for extensions living outside of the panel, in the window manager dock area (as defined in the  [http://www.freedesktop.org/standards/wm-spec.html freedesktop.org window manager specifications] and are managed by the panel. Examples for panel extensions are the external task bar and the dock application bar which adds support for [http://www.windowmaker.org Window Maker] applets and other applications using the standard X11 docking mechanism to kicker.
    
− Starting with a short technology overview this tutorial discusses the implementation of a simple panel applet. Both the applet and extension APIs are simple. This qualifies writing a panel applet as a suitable task for an introduction to KDE programming. This tutorial presumes that the reader has some basic C++ and Qt knowledge. You can find a basic Qt tutorial at:  [http://doc.trolltech.com/tutorial.html http://doc.trolltech.com/tutorial.html] + Starting with a short technology overview this tutorial discusses the implementation of a simple panel applet. Both the applet and extension APIs are simple. This qualifies writing a panel applet as a suitable task for an introduction to KDE programming. This tutorial presumes that the reader has some basic C++ and Qt knowledge. You can also start with [http://doc.trolltech.com/2.3/tutorial.html a basic Qt2 tutorial].
    
  == Overview ==   == Overview ==
Line 163:
Line 163:
  Searching for a panel applet suitable for this tutorial I stumbled over a screenshot of an applet implementation of the old fifteen pieces game for another desktop environment. While it's more a toy than of any real use it is simple and fast to implement and thus perfect for a tutorial. I'm sure you know the fifteen pieces game with the goal to put fifteen sliding pieces into numerical oder. The idea of the game is that on a 4x4 cell quadratic game board fifteen numbered (1 to 15) quadratic pieces must be put into numerical order while pieces can only be moved horizontally or vertically and with only one free cell to perform move operations on.   Searching for a panel applet suitable for this tutorial I stumbled over a screenshot of an applet implementation of the old fifteen pieces game for another desktop environment. While it's more a toy than of any real use it is simple and fast to implement and thus perfect for a tutorial. I'm sure you know the fifteen pieces game with the goal to put fifteen sliding pieces into numerical oder. The idea of the game is that on a 4x4 cell quadratic game board fifteen numbered (1 to 15) quadratic pieces must be put into numerical order while pieces can only be moved horizontally or vertically and with only one free cell to perform move operations on.
    
− We are going to use a customized {{qt|QTableView}} widget for the game board. Similar to the hello world applet our little project will consist of three files, {{path|fiftenapplet.cpp}}, {{path|fifteenapplet.h}}, {{path|fifteenapplet.desktop}} and the {{path|Makefile.am}} file. + We are going to use a customized {{qt2|QTableView}} widget for the game board. Similar to the hello world applet our little project will consist of three files, {{path|fiftenapplet.cpp}}, {{path|fifteenapplet.h}}, {{path|fifteenapplet.desktop}} and the {{path|Makefile.am}} file.
    
  {{path|fifteenapplet.h}} contains the declaration of FifteenApplet, the class inheriting from KPanelApplet :   {{path|fifteenapplet.h}} contains the declaration of FifteenApplet, the class inheriting from KPanelApplet :
Line 417:
Line 417:
  }   }
  </code>   </code>
− We have reimplemented void paintCell() from QTableView to actually paint the table cells, which on our game board represent sliding pieces, when the widgets receives a paint event. The function is a bit to long to explain in all detail but is quite easy to understand looking up calls you are unsure about in the Qt documentation for {{qt3|QPainter}} and {{qt3|QTableView}} + We have reimplemented void paintCell() from QTableView to actually paint the table cells, which on our game board represent sliding pieces, when the widgets receives a paint event. The function is a bit to long to explain in all detail but is quite easy to understand looking up calls you are unsure about in the Qt documentation for {{qt2|QPainter}} and {{qt2|QTableView}}
  <code cppqt n>   <code cppqt n>
  void PiecesTable::resizeEvent(QResizeEvent *e)     void PiecesTable::resizeEvent(QResizeEvent *e)  



Dhaumann: Development/Tutorials/KDE3/Extending the KDE Panel moved to Development/Tutorials/KDE2/Extending the KDE Panel: wrong category
2007-07-11T20:14:31Z
Development/Tutorials/KDE3/Extending the KDE Panel moved to Development/Tutorials/KDE2/Extending the KDE Panel: wrong category

			
			← Older revision
			Revision as of 20:14, 11 July 2007
			


Dhaumann: it's KDE2 stuff
2007-07-11T20:13:32Z
it's KDE2 stuff

				
				
				
				
			
			← Older revision
			Revision as of 20:13, 11 July 2007
			
Line 1:
Line 1:
− [[Category:KDE3]] + [[Category:KDE2]]
  == Introduction ==   == Introduction ==
    



Tampakrap: /* Introduction */
2007-05-31T13:20:37Z
‎Introduction

				
				
				
				
			
			← Older revision
			Revision as of 13:20, 31 May 2007
			
Line 1:
Line 1:
  [[Category:KDE3]]   [[Category:KDE3]]
  == Introduction ==   == Introduction ==
− ... +  
  The KDE panel (below referred to as "kicker") has been rewritten from scratch for KDE 2.0 and one of the main goals of the rewrite was to increase extensibility. For this reason with KDE 2.0 an API for panel applets has been introduced followed by an API for panel extension introduced with the KDE 2.1 release. Panel applets and extensions are simply referred to as "plugins" in the following paragraphs.   The KDE panel (below referred to as "kicker") has been rewritten from scratch for KDE 2.0 and one of the main goals of the rewrite was to increase extensibility. For this reason with KDE 2.0 an API for panel applets has been introduced followed by an API for panel extension introduced with the KDE 2.1 release. Panel applets and extensions are simply referred to as "plugins" in the following paragraphs.
    





Tampakrap at 13:20, 31 May 2007
2007-05-31T13:20:15Z


				
				
				
				
			
			← Older revision
			Revision as of 13:20, 31 May 2007
			
Line 1:
Line 1:
  [[Category:KDE3]]   [[Category:KDE3]]
  == Introduction ==   == Introduction ==
−  + ...
  The KDE panel (below referred to as "kicker") has been rewritten from scratch for KDE 2.0 and one of the main goals of the rewrite was to increase extensibility. For this reason with KDE 2.0 an API for panel applets has been introduced followed by an API for panel extension introduced with the KDE 2.1 release. Panel applets and extensions are simply referred to as "plugins" in the following paragraphs.   The KDE panel (below referred to as "kicker") has been rewritten from scratch for KDE 2.0 and one of the main goals of the rewrite was to increase extensibility. For this reason with KDE 2.0 an API for panel applets has been introduced followed by an API for panel extension introduced with the KDE 2.1 release. Panel applets and extensions are simply referred to as "plugins" in the following paragraphs.
    



Pino: more use of {{path}}
2007-05-29T22:51:35Z
more use of {{path}}
Show changes

← Older revision		Revision as of 20:13, 11 July 2007
Line 1:		Line 1:
−	[[Category:~~KDE3~~]]	+	[[Category:KDE2]]
	== Introduction ==		== Introduction ==