Development/Tutorials/Decibel/Handling TextChannels - Revision history

Icwiener: Text replace - "
2011-06-30T11:33:46Z

Text replace - "<syntaxhighlight lang="bash"" to "<syntaxhighlight lang="cmake""

← Older revision Revision as of 11:33, 30 June 2011
Line 205: Line 205:

==CMakeLists.txt==

==CMakeLists.txt==

Since this example program is built as part of the main Decibel sources, I will not explain here how to create a standalone <tt>CMakeLists.txt</tt> file to build it, but will instead explain the important parts of the <tt>CMakeLists.txt</tt> file as found in the Decibel sources for this subdirectory. For more information on how <tt>CMakeLists.txt</tt> files work, please see the [[Development/Tutorials/CMake|Introduction to cmake]] tutorial.

Since this example program is built as part of the main Decibel sources, I will not explain here how to create a standalone <tt>CMakeLists.txt</tt> file to build it, but will instead explain the important parts of the <tt>CMakeLists.txt</tt> file as found in the Decibel sources for this subdirectory. For more information on how <tt>CMakeLists.txt</tt> files work, please see the [[Development/Tutorials/CMake|Introduction to cmake]] tutorial.

−
<syntaxhighlight lang="bash">
+
<syntaxhighlight lang="cmake">

SET(QT_DONT_USE_QTGUI "YES")

SET(QT_DONT_USE_QTGUI "YES")

INCLUDE(${QT_USE_FILE})

INCLUDE(${QT_USE_FILE})

Neverendingo: /* CMakeLists.txt */

2011-06-29T19:33:41Z

‎CMakeLists.txt

Neverendingo: /* The .service File */

2011-06-29T19:32:16Z

‎The .service File

Neverendingo: /* The .component File */

2011-06-29T19:32:02Z

‎The .component File

Neverendingo: Text replace - "" to ""

2011-06-29T19:16:06Z

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

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


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

				
				
				
				
			
			← Older revision
			Revision as of 19:13, 29 June 2011
			
Line 23:
Line 23:
  Here is the class definition for our implementation of the <tt>Decibel::ChannelHandler</tt> interface. It is explained below.   Here is the class definition for our implementation of the <tt>Decibel::ChannelHandler</tt> interface. It is explained below.
    
− <code cppqt> + <syntaxhighlight lang="cpp-qt">
  class MyTextChannelHandler : public Decibel::ChannelHandler   class MyTextChannelHandler : public Decibel::ChannelHandler
  {   {
Line 51:
Line 51:
    
  ====Constructor====   ====Constructor====
− <code cppqt> + <syntaxhighlight lang="cpp-qt">
  MyTextChannelHandler::MyTextChannelHandler(QObject * parent) :   MyTextChannelHandler::MyTextChannelHandler(QObject * parent) :
       ChannelHandler(parent),        ChannelHandler(parent),
Line 61:
Line 61:
    
  ====Destructor====   ====Destructor====
− <code cppqt> + <syntaxhighlight lang="cpp-qt">
  MyTextChannelHandler::~MyTextChannelHandler()   MyTextChannelHandler::~MyTextChannelHandler()
  { }   { }
Line 68:
Line 68:
    
  ====handleChannel()====   ====handleChannel()====
− <code cppqt> + <syntaxhighlight lang="cpp-qt">
  bool MyTextChannelHandler::handleChannel(QtTapioca::Connection * connection,   bool MyTextChannelHandler::handleChannel(QtTapioca::Connection * connection,
                                            QtTapioca::Channel * channel,                                             QtTapioca::Channel * channel,
Line 109:
Line 109:
    
  ====onCloseChannel()====   ====onCloseChannel()====
− <code cppqt> + <syntaxhighlight lang="cpp-qt">
  void MyTextChannelHandler::onCloseChannel()   void MyTextChannelHandler::onCloseChannel()
  {   {
Line 119:
Line 119:
    
  ====onMessageReceived()====   ====onMessageReceived()====
− <code cppqt> + <syntaxhighlight lang="cpp-qt">
  void MyTextChannelHandler::onMessageReceived()   void MyTextChannelHandler::onMessageReceived()
  {   {
Line 148:
Line 148:
  ==The main() function==   ==The main() function==
    
− <code cppqt> + <syntaxhighlight lang="cpp-qt">
  int main(int argc, char ** argv)   int main(int argc, char ** argv)
  {   {



Grundleborg: Correct the svn link
2008-09-09T16:30:17Z
Correct the svn link

				
				
				
				
			
			← Older revision
			Revision as of 16:30, 9 September 2008
			
Line 15:
Line 15:
  This tutorial is based on the simpleclient demo included with Decibel. An explanation of using the simpleclient demo can be [[Development/Tutorials/Decibel/GettingStarted#simpleclient|found here]].   This tutorial is based on the simpleclient demo included with Decibel. An explanation of using the simpleclient demo can be [[Development/Tutorials/Decibel/GettingStarted#simpleclient|found here]].
    
− In this tutorial, we only pick out the important parts of the source code to discuss. The complete working source code for this example can be found [http://websvn.kde.org/trunk/kdereview/decibel/demos/simpleclient here in KDE's SVN Repository]. + In this tutorial, we only pick out the important parts of the source code to discuss. The complete working source code for this example can be found [http://websvn.kde.org/trunk/kdesupport/decibel/demos/simpleclient here in KDE's SVN Repository].
    
  ==ChannelHandler class==   ==ChannelHandler class==



Grundleborg: User:Grundleborg/Handling TextChannels moved to Development/Tutorials/Decibel/Handling TextChannels over redirect: Tutorial is finished, so put it in its final place with other Decibel tutorials
2008-03-30T09:01:39Z
User:Grundleborg/Handling TextChannels moved to Development/Tutorials/Decibel/Handling TextChannels over redirect: Tutorial is finished, so put it in its final place with other Decibel tutorials

			
			← Older revision
			Revision as of 09:01, 30 March 2008
			


Grundleborg: fix formatting
2008-03-30T08:57:57Z
fix formatting

				
				
				
				
			
			← Older revision
			Revision as of 08:57, 30 March 2008
			
Line 5:
Line 5:
  name=Handling TextChannels|   name=Handling TextChannels|
    
− pre=[http://mindview.net/Books/TICPP/ThinkingInCPP2e.html C++], [http://www.trolltech.com/products/qt/ Qt],   + pre=[http://mindview.net/Books/TICPP/ThinkingInCPP2e.html C++], [http://www.trolltech.com/products/qt/ Qt], [[Development/Tutorials/Decibel/GettingStarted|Getting Started with Decibel]]|  
− [[Development/Tutorials/Decibel/GettingStarted|Getting Started with Decibel]]|   + 
−   + 
  next=|     next=|  
    



Grundleborg: fix layout
2008-03-30T08:57:07Z
fix layout

				
				
				
				
			
			← Older revision
			Revision as of 08:57, 30 March 2008
			
Line 5:
Line 5:
  name=Handling TextChannels|   name=Handling TextChannels|
    
− pre=[http://mindview.net/Books/TICPP/ThinkingInCPP2e.html C++], [http://www.trolltech.com/products/qt/ Qt], + pre=[http://mindview.net/Books/TICPP/ThinkingInCPP2e.html C++], [http://www.trolltech.com/products/qt/ Qt],  
− [[Development/Tutorials/Decibel/GettingStarted|Getting Started with Decibel]]| + [[Development/Tutorials/Decibel/GettingStarted|Getting Started with Decibel]]|  
    
  next=|     next=|

@@ Line 196: / Line 196: @@
 In order to have dbus automatically start our application when Decibel tries to communicate with it, we must create a <tt>.service</tt> file.
-<code ini>
+<syntaxhighlight lang="ini">
 [D-BUS Service]
 Name=org.kde.SimpleClient

@@ Line 179: / Line 179: @@
 The contents of our demo application's <tt>.component</tt> file are as follows.
-<code ini>
+<syntaxhighlight lang="ini">
 [Component]
 Name=Simpleclient
@@ Line 189: / Line 189: @@
 </syntaxhighlight>
-The only group in this file is the <tt><nowiki>[Component]</nowiki></tt> group. It contains a series of keys idntifying our application to Decibel and detailing the funcionality it supports.
+The only group in this file is the <tt><nowiki>[Component]</nowiki></tt> group. It contains a series of keys identifying our application to Decibel and detailing the funcionality it supports.
 In this example, the important keys are the <tt>Service%20Name</tt> which tells Decibel the dbus name of our application, and the <tt>Object%20Path</tt> which tells Decibel the dbus object path that should be called on our application.

@@ Line 42: / Line 42: @@
      QtTapioca::TextChannel * m_channel;
 };
-</code>
+</syntaxhighlight>
 We must inherit from <tt>Decibel::ChannelHandler</tt> which is the interface definition for handling incoming Channels. We reimplement the constructor, Destructor and the <tt>handleChannel()</tt> method as well as adding two slots of our own. We also create the member variables <tt>m_connecion</tt> and <tt>m_channel</tt> which will hold the <tt>QtTapioca::Connection</tt> and <tt>QtTapioca::Channel</tt> objects that are received by the <tt>handleChannel</tt> method.
@@ Line 57: / Line 57: @@
      m_channel(0)
 { }
-</code>
+</syntaxhighlight>
 The constructor is very simple. We just pass the <tt>parent</tt> object on to the parent class and initialise our member variables to <tt>0</tt>.
@@ Line 64: / Line 64: @@
 MyTextChannelHandler::~MyTextChannelHandler()
 { }
-</code>
+</syntaxhighlight>
 The destructor is even simpler. We don't need to do anything in it because Qt will handle the deletion of child objects automatically.
@@ Line 93: / Line 93: @@
      return true;
+}
-</code>
+</syntaxhighlight>
 This method is reimplemented from the <tt>Decibel::ChannelHandler</tt> interface. It is called when ever a new incoming communication channel (<tt>QtTapioca::Channel</tt>) comes into existence. In this method, we must decide whether to accept the incoming channel, and if so, to deal with it appropriately.
@@ Line 115: / Line 115: @@
      m_channel = 0;
+}
-</code>
+</syntaxhighlight>
 This slot is called when the current TextChannel is closed. It resets the <tt>m_connection</tt> and <tt>m_channel</tt> member variables to <tt>0</tt> so that the <tt>handleChannel()</tt> method will accept the next incoming channel.
@@ Line 135: / Line 135: @@
+     }
+}
-</code>
+</syntaxhighlight>
 This slot is called when a new message is received on the channel we are currently handling. It is where the processing of the message takes place.
@@ Line 164: / Line 164: @@
      return app.exec();
+}
-</code>
+</syntaxhighlight>
 Since this is a console application, we set up a <tt>QCoreApplication</tt> first.
@@ Line 187: / Line 187: @@
 Service%20Name=org.kde.SimpleClient
 Object%20Path=/TextChannelHandler
-</code>
+</syntaxhighlight>
 The only group in this file is the <tt><nowiki>[Component]</nowiki></tt> group. It contains a series of keys idntifying our application to Decibel and detailing the funcionality it supports.
@@ Line 200: / Line 200: @@
 Name=org.kde.SimpleClient
 Exec=@INSTALL_DIR@/decibel_simpleclient_demo
-</code>
+</syntaxhighlight>
 This is a standard dbus autostart file. It contains the dbus name of our application and the absolute path to it. <tt>@INSTALL_DIR</tt> will be replaced automatically by the installation directory using cmake in the next step.
@@ Line 224: / Line 224: @@
                 "${CMAKE_CURRENT_BINARY_DIR}/${SERVICE_FILE}"
+)
-</code>
+</syntaxhighlight>
 The <tt>CONFIGURE_FILE</tt> line above tells cmake tp fill in the variable to the <tt>.service.cmake</tt> file we previously created.
@@ Line 258: / Line 258: @@
          DESTINATION ${COMPONENT_SEARCH_DIR}
+)
-</code>
+</syntaxhighlight>
 ==Running our Application==

@@ Line 205: / Line 205: @@
 ==CMakeLists.txt==
 Since this example program is built as part of the main Decibel sources, I will not explain here how to create a standalone <tt>CMakeLists.txt</tt> file to build it, but will instead explain the important parts of the <tt>CMakeLists.txt</tt> file as found in the Decibel sources for this subdirectory. For more information on how <tt>CMakeLists.txt</tt> files work, please see the [[Development/Tutorials/CMake|Introduction to cmake]] tutorial.
-<syntaxhighlight lang="bash">
+<syntaxhighlight lang="cmake">
 SET(QT_DONT_USE_QTGUI "YES")
 INCLUDE(${QT_USE_FILE})