Development/Languages/Python/PyKDE Knotify Tutorial - Revision history

AnneW at 16:22, 19 July 2012

2012-07-19T16:22:43Z

Macdems at 13:04, 4 September 2011

2011-09-04T13:04:31Z

Neverendingo: Text replace - "" to ""

2011-06-29T20:49:58Z

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

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


2011-06-29T20:33:51Z
Text replace - "<code python>" to "<syntaxhighlight lang="python">"

				
				
				
				
			
			← Older revision
			Revision as of 20:33, 29 June 2011
			
Line 24:
Line 24:
  We start with a minimal KDE Appliciation ([http://techbase.kde.org/Development/Languages/Python/Using_PyKDE_4 Using PyKDE4]):   We start with a minimal KDE Appliciation ([http://techbase.kde.org/Development/Languages/Python/Using_PyKDE_4 Using PyKDE4]):
    
− <code python> + <syntaxhighlight lang="python">
  #! /usr/bin/python   #! /usr/bin/python
  # -*- coding: utf-8 -*-   # -*- coding: utf-8 -*-
Line 61:
Line 61:
  So it is easy to write a small Job-Class:   So it is easy to write a small Job-Class:
    
− <code python> + <syntaxhighlight lang="python">
  from PyQt4.QtCore import QObject,QTimer,QString   from PyQt4.QtCore import QObject,QTimer,QString
  from PyKDE4.kdecore import KJob   from PyKDE4.kdecore import KJob
Line 134:
Line 134:
  ===How to use?===   ===How to use?===
  Just create a instance of this class and start it:   Just create a instance of this class and start it:
− <code python> + <syntaxhighlight lang="python">
  job=MyJob(app)   job=MyJob(app)
  job.start()   job.start()
Line 141:
Line 141:
  ===We want to know when the jobs done?===   ===We want to know when the jobs done?===
  Create a '''SLOT''' to the '''result'''-signal:   Create a '''SLOT''' to the '''result'''-signal:
− <code python> + <syntaxhighlight lang="python">
  def handleResult(job):   def handleResult(job):
       #handleResult Function        #handleResult Function
Line 161:
Line 161:
  Till now, a normal user doesn't see anything what is going on. To change it we have to register the Job to a JobTracker.  Now a user will see a progressbar and a suspend and a stop button. So we modify the start method:   Till now, a normal user doesn't see anything what is going on. To change it we have to register the Job to a JobTracker.  Now a user will see a progressbar and a suspend and a stop button. So we modify the start method:
    
− <code python> + <syntaxhighlight lang="python">
  from PyKDE4.kio import KIO   from PyKDE4.kio import KIO
  ...   ...



Hefee: terimation
2010-08-10T00:10:51Z
terimation

				
				
				
				
			
			← Older revision
			Revision as of 00:10, 10 August 2010
			
Line 149:
Line 149:
       else:        else:
          print 'job has terminated successfully'           print 'job has terminated successfully'
  +     
  +     #for terimation the complete application
  +     sys.exit()
    
  job.result.connect(handleResult)   job.result.connect(handleResult)
  </code>   </code>
  + 
  + Now we also add '''app.exec_()''' at the end of the main part, to prevent the program to stop before the job is stopped.
    
  ===Visual feedback===   ===Visual feedback===





Hefee: /* Job class */ KDE 4.3
2010-08-09T23:54:56Z
‎Job class:  KDE 4.3

				
				
				
				
			
			← Older revision
			Revision as of 23:54, 9 August 2010
			
Line 56:
Line 56:
  == Job class ==   == Job class ==
  The first step is to have a look to the [http://api.kde.org]. The intersting on is:   The first step is to have a look to the [http://api.kde.org]. The intersting on is:
− * [http://api.kde.org/pykde-4.1-api/kdecore/KJob.html KJob(KDE 4.1-PyKDE4)]- unfortunately this documention is only available for KDE 4.1. So we have also a look to the actual C++ Doumentation + * [http://api.kde.org/pykde-4.3-api/kdecore/KJob.html KJob(KDE 4.3-PyKDE4)]- unfortunately this documention is only available for KDE 4.3. So we have also a look to the actual C++ Doumentation
  * [http://api.kde.org/4.x-api/kdelibs-apidocs/kdecore/html/classKJob.html KJob(KJob 4.x-C++API)]   * [http://api.kde.org/4.x-api/kdelibs-apidocs/kdecore/html/classKJob.html KJob(KJob 4.x-C++API)]
    



Hefee: /* Job class */ indent error
2010-08-09T23:50:32Z
‎Job class:  indent error

				
				
				
				
			
			← Older revision
			Revision as of 23:50, 9 August 2010
			
Line 86:
Line 86:
                                                                                                                                                                                                                                                                                                       
       def doWork(self):                      def doWork(self):              
−       #the actual work                                           +         #the actual work                                          
−       try:              +         try:             
               #if we are killed or suspended just return                                                            #if we are killed or suspended just return                                            
               if self.error() or self.isSuspended():                                     if self.error() or self.isSuspended():                     





Hefee: How to use/Visible feed/Conclusion
2010-08-09T23:40:10Z
How to use/Visible feed/Conclusion

				
				
				
				
			
			← Older revision
			Revision as of 23:40, 9 August 2010
			
Line 83:
Line 83:
           #start the actual work in another thread            #start the actual work in another thread
           #this function has to terminate, before the work is done            #this function has to terminate, before the work is done
−          QTimer().singleShot( 0, self.doWork ) +          QTimer().singleShot(0, self.doWork)
                                                                                                                                                                                                                                                                                                       
       def doWork(self):                      def doWork(self):              
Line 108:
Line 108:
               return                  return  
           #just go to sleep for 1000ms than go on            #just go to sleep for 1000ms than go on
−          QTimer().singleShot( 1000, self.doWork ) +          QTimer().singleShot(1000, self.doWork)
                 
       def doSuspend(self):        def doSuspend(self):
Line 131:
Line 131:
  * '''MyJob.doWork''': Do actual work and handle, if this job is killed or suspended.   * '''MyJob.doWork''': Do actual work and handle, if this job is killed or suspended.
  * '''MyJob.doSuspend'''/'''MyJob.doResume'''/'''MyJob.doKill''': These function indicate that this feature is supported by this class.   * '''MyJob.doSuspend'''/'''MyJob.doResume'''/'''MyJob.doKill''': These function indicate that this feature is supported by this class.
  + 
  + ===How to use?===
  + Just create a instance of this class and start it:
  + <code python>
  + job=MyJob(app)
  + job.start()
  + </code>
  + 
  + ===We want to know when the jobs done?===
  + Create a '''SLOT''' to the '''result'''-signal:
  + <code python>
  + def handleResult(job):
  +     #handleResult Function
  +     #it is called when the job is terminating
  +     if job.error():
  +        print 'error happend'
  +     else:
  +        print 'job has terminated successfully'
  + 
  + job.result.connect(handleResult)
  + </code>
  + 
  + ===Visual feedback===
  + Till now, a normal user doesn't see anything what is going on. To change it we have to register the Job to a JobTracker.  Now a user will see a progressbar and a suspend and a stop button. So we modify the start method:
  + 
  + <code python>
  + from PyKDE4.kio import KIO
  + ...
  +     def start(self):
  +         #register the Job to the JobTracker
  +         KIO.getJobTracker().registerJob(self)
  +         self.i=0
  +         QTimer().singleShot(0, self.doWork)
  + </code>
  + 
  + === Conclusion ===
  + Here is the [[Development/Languages/Python/PyKDE_Knotify_Tutorial/MyJob.py|full code]] of this example. 
  + 
  + Is is very easy to create a Job and make it visible to normal users. Unfortunately I have problems with setting the heading and description, so this will be added in later versions.



Hefee: whats going on?
2010-08-09T23:18:46Z
whats going on?

				
				
				
				
			
			← Older revision
			Revision as of 23:18, 9 August 2010
			
Line 81:
Line 81:
           self.i=0            self.i=0
                       
−          #start the actual work in another thread - this function has to terminate, before the work is done +          #start the actual work in another thread
  +         #this function has to terminate, before the work is done
           QTimer().singleShot( 0, self.doWork )            QTimer().singleShot( 0, self.doWork )
                                                                                                                                                                                                                                                                                                       
Line 91:
Line 92:
                   return                    return
           except RuntimeError:            except RuntimeError:
−              #if this class is killed before this functions is called a RuntimeError will raise +              #if this class is killed before a RuntimeError will raise
               return                return
    
Line 97:
Line 98:
           self.i+=1            self.i+=1
    
−          #fortunately we have made a peace of work -> show this to everybody +          #fortunately we have made a peace of work  
  +         #-> show this to everybody
           KJob.setPercent(self,self.i*4)            KJob.setPercent(self,self.i*4)
                       
Line 123:
Line 125:
           return True            return True
  </code>   </code>
  + 
  + ===What is going on?===
  + * '''MyJob.__init__''': First we create the class and initialize the counter ''i'' and the maximum ''max''. To make is visible for others we set the Capacities, so this job is suspendable and killable.
  + * '''MyJob.start''': Here the pre working setting are made, we will se later for what we use this. After initalizing the Work we start the actual work by using a QTimer. The start method should start the asyncron.
  + * '''MyJob.doWork''': Do actual work and handle, if this job is killed or suspended.
  + * '''MyJob.doSuspend'''/'''MyJob.doResume'''/'''MyJob.doKill''': These function indicate that this feature is supported by this class.



Hefee: i18n tamplate
2010-08-09T23:06:01Z
i18n tamplate

				
				
				
				
			
			← Older revision
			Revision as of 23:06, 9 August 2010
			
Line 1:
Line 1:
− {{Template:I18n/Language Navigation Bar|Development/Tutorials/Python/PyKDE_KNotify_Tutorial}} + {{Template:I18n/Language Navigation Bar|Development/Languages/Python/PyKDE_Knotify_Tutorial}}
    
  {{TutorialBrowser|   {{TutorialBrowser|

← Older revision		Revision as of 16:22, 19 July 2012
Line 1:		Line 1:
−	~~{{Template:I18n/Language Navigation Bar\|Development/Languages/Python/PyKDE_Knotify_Tutorial}}~~	+

	{{TutorialBrowser\|		{{TutorialBrowser\|

@@ Line 52: / Line 52: @@
      app = KApplication ()
-</code>
+</syntaxhighlight>
 == Job class ==
@@ Line 124: / Line 124: @@
          #return True for signaling that we support killing
          return True
-</code>
+</syntaxhighlight>
 ===What is going on?===
@@ Line 137: / Line 137: @@
 job=MyJob(app)
 job.start()
-</code>
+</syntaxhighlight>
 ===We want to know when the jobs done?===
@@ Line 154: / Line 154: @@
 job.result.connect(handleResult)
-</code>
+</syntaxhighlight>
 Now we also add '''app.exec_()''' at the end of the main part, to prevent the program to stop before the job is stopped.
@@ Line 169: / Line 169: @@
          self.i=0
          QTimer().singleShot(0, self.doWork)
-</code>
+</syntaxhighlight>
 === Conclusion ===

← Older revision		Revision as of 23:06, 9 August 2010
Line 1:		Line 1:
−	{{Template:I18n/Language Navigation Bar\|Development/~~Tutorials~~/Python/~~PyKDE_KNotify_Tutorial~~}}	+	{{Template:I18n/Language Navigation Bar\|Development/Languages/Python/PyKDE_Knotify_Tutorial}}

	{{TutorialBrowser\|		{{TutorialBrowser\|