Development/Tutorials/KSpread Scripting - Revision history

Neverendingo: Text replace - "" to ""

2011-06-29T20:52:32Z

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

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


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

				
				
				
				
			
			← Older revision
			Revision as of 20:44, 29 June 2011
			
Line 229:
Line 229:
  [http://websvn.kde.org/trunk/koffice/kspread/plugins/scripting/scripts/scripts.rc?view=markup scripts.rc] in a collection named "docker". If KSpread starts and the scripting plugin got loaded, for each script within that "docker" collection a Docker will be created. Once such a docker got shown/displayed, the defined scripting file will be executed.   [http://websvn.kde.org/trunk/koffice/kspread/plugins/scripting/scripts/scripts.rc?view=markup scripts.rc] in a collection named "docker". If KSpread starts and the scripting plugin got loaded, for each script within that "docker" collection a Docker will be created. Once such a docker got shown/displayed, the defined scripting file will be executed.
    
− <code> + <syntaxhighlight lang="text">
  <collection name="docker" text="Docker">   <collection name="docker" text="Docker">
       <script        <script
Line 268:
Line 268:
  Just like at the [[Development/Tutorials/KSpread_Scripting#Python_Console|Python Console]] script above we registered the [http://websvn.kde.org/trunk/koffice/kspread/plugins/scripting/scripts/snippetsdocker.rb?view=markup snippetsdocker.rb] Ruby script in the [http://websvn.kde.org/trunk/koffice/kspread/plugins/scripting/scripts/scripts.rc?view=markup scripts.rc] file in the "docker" collection;   Just like at the [[Development/Tutorials/KSpread_Scripting#Python_Console|Python Console]] script above we registered the [http://websvn.kde.org/trunk/koffice/kspread/plugins/scripting/scripts/snippetsdocker.rb?view=markup snippetsdocker.rb] Ruby script in the [http://websvn.kde.org/trunk/koffice/kspread/plugins/scripting/scripts/scripts.rc?view=markup scripts.rc] file in the "docker" collection;
    
− <code> + <syntaxhighlight lang="text">
  <collection name="docker" text="Docker">   <collection name="docker" text="Docker">
       <script        <script



Neverendingo: Text replace - "" to ""

2011-06-29T20:42:31Z
Text replace - "<code ruby>" to "<syntaxhighlight lang="ruby">"

				
				
				
				
			
			← Older revision
			Revision as of 20:42, 29 June 2011
			
Line 255:
Line 255:
  We connect Kross with QtRuby using following ruby code;   We connect Kross with QtRuby using following ruby code;
    
− <code ruby> + <syntaxhighlight lang="ruby">
  # Fetch the QDockWidget as void-pointer.   # Fetch the QDockWidget as void-pointer.
  $voidptr = KoDocker.toVoidPtr()   $voidptr = KoDocker.toVoidPtr()



Neverendingo: Text replace - "" to ""

2011-06-29T20:39:21Z
Text replace - "<code bash>" to "<syntaxhighlight lang="bash">"

				
				
				
				
			
			← Older revision
			Revision as of 20:39, 29 June 2011
			
Line 133:
Line 133:
  Now we run KSpread with the --scriptfile argument that points to the delivered [http://websvn.kde.org/trunk/koffice/kspread/plugins/scripting/scripts/functions.py?view=markup functions.py]   Now we run KSpread with the --scriptfile argument that points to the delivered [http://websvn.kde.org/trunk/koffice/kspread/plugins/scripting/scripts/functions.py?view=markup functions.py]
  example.   example.
− <code bash> + <syntaxhighlight lang="bash">
  # make the script executable   # make the script executable
  chmod 755 `kde4-config --install data`/kspread/scripts/functions/functions.py   chmod 755 `kde4-config --install data`/kspread/scripts/functions/functions.py
Line 348:
Line 348:
  script distributed with KSpread could also be executed from   script distributed with KSpread could also be executed from
  the commandline;   the commandline;
− <code bash> + <syntaxhighlight lang="bash">
  # make the script executable   # make the script executable
  chmod 755 `kde4-config --install data`/kspread/scripts/extensions/htmlexport.py   chmod 755 `kde4-config --install data`/kspread/scripts/extensions/htmlexport.py



Neverendingo: Text replace - "" to ""

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

				
				
				
				
			
			← Older revision
			Revision as of 20:34, 29 June 2011
			
Line 93:
Line 93:
  The [http://websvn.kde.org/trunk/koffice/kspread/plugins/scripting/scripts/functions.py?view=markup functions.py]   The [http://websvn.kde.org/trunk/koffice/kspread/plugins/scripting/scripts/functions.py?view=markup functions.py]
  Python script demonstrates this by defining the KSpread formula function "SCRIPT_TEST1";   Python script demonstrates this by defining the KSpread formula function "SCRIPT_TEST1";
− <code python> + <syntaxhighlight lang="python">
  # create the new formula function "SCRIPT_TEST1"   # create the new formula function "SCRIPT_TEST1"
  functest1 = self.kspread.function("SCRIPT_TEST1")   functest1 = self.kspread.function("SCRIPT_TEST1")
Line 213:
Line 213:
  The script does use PyQt4 to embed widgets like a QTextBrowser or a QTreeView for the GUI related stuff. For this we use PyQt's SIP to pass around void* pointers. The following python code demonstrates how KSpread's KoScriptingDocker provided on the fly via [[Development/Tutorials/Kross/Introduction|Kross]] got translated into the PyQt world.   The script does use PyQt4 to embed widgets like a QTextBrowser or a QTreeView for the GUI related stuff. For this we use PyQt's SIP to pass around void* pointers. The following python code demonstrates how KSpread's KoScriptingDocker provided on the fly via [[Development/Tutorials/Kross/Introduction|Kross]] got translated into the PyQt world.
    
− <code python> + <syntaxhighlight lang="python">
  # Import needed modules   # Import needed modules
  import KoDocker, PyQt4.Qt as Qt, sip   import KoDocker, PyQt4.Qt as Qt, sip
Line 306:
Line 306:
    
  The csvexport.py Python script looks like;   The csvexport.py Python script looks like;
− <code python> + <syntaxhighlight lang="python">
  #!/usr/bin/env kross   #!/usr/bin/env kross
    
Line 374:
Line 374:
    
  The invoice.py Python script looks like;   The invoice.py Python script looks like;
− <code python> + <syntaxhighlight lang="python">
  #!/usr/bin/env kross   #!/usr/bin/env kross
    
Line 423:
Line 423:
    
  ===Get and set values in a cell===   ===Get and set values in a cell===
− <code python> + <syntaxhighlight lang="python">
  import KSpread   import KSpread
  sheet = KSpread.view().sheet()   sheet = KSpread.view().sheet()
Line 439:
Line 439:
    
  ===Do something if a value in a cell changed===   ===Do something if a value in a cell changed===
− <code python> + <syntaxhighlight lang="python">
  import KSpread   import KSpread
  # the sheet we like to listen to   # the sheet we like to listen to
Line 455:
Line 455:
    
  ===Print all values in all sheets===   ===Print all values in all sheets===
− <code python> + <syntaxhighlight lang="python">
  import KSpread   import KSpread
  for n in KSpread.sheetNames():   for n in KSpread.sheetNames():
Line 467:
Line 467:
    
  ===Translate between name and coordinates of a cells===   ===Translate between name and coordinates of a cells===
− <code python> + <syntaxhighlight lang="python">
  import KSpread   import KSpread
  sheet = KSpread.view().sheet()   sheet = KSpread.view().sheet()
Line 481:
Line 481:
    
  ===Get and set active sheet===   ===Get and set active sheet===
− <code python> + <syntaxhighlight lang="python">
  import KSpread   import KSpread
  view = KSpread.view()   view = KSpread.view()
Line 498:
Line 498:
    
  ===Get and set selected cells===   ===Get and set selected cells===
− <code python> + <syntaxhighlight lang="python">
  import KSpread   import KSpread
  view = KSpread.view()   view = KSpread.view()
Line 506:
Line 506:
    
  ===Do something if the selection changed===   ===Do something if the selection changed===
− <code python> + <syntaxhighlight lang="python">
  import KSpread   import KSpread
  view = KSpread.view()   view = KSpread.view()
Line 517:
Line 517:
    
  ===Change the name of a sheet===   ===Change the name of a sheet===
− <code python> + <syntaxhighlight lang="python">
  import KSpread   import KSpread
  sheet = KSpread.currentSheet()   sheet = KSpread.currentSheet()
Line 525:
Line 525:
    
  ===Do something if the name of a sheet changed===   ===Do something if the name of a sheet changed===
− <code python> + <syntaxhighlight lang="python">
  import KSpread   import KSpread
  sheet = KSpread.currentSheet()   sheet = KSpread.currentSheet()
Line 537:
Line 537:
    
  ===Hide or show sheets===   ===Hide or show sheets===
− <code python> + <syntaxhighlight lang="python">
  import KSpread   import KSpread
  for n in KSpread.sheetNames():   for n in KSpread.sheetNames():
Line 548:
Line 548:
    
  ===Do something if a sheet got hidden/shown===   ===Do something if a sheet got hidden/shown===
− <code python> + <syntaxhighlight lang="python">
  import KSpread   import KSpread
  sheet = KSpread.currentSheet()   sheet = KSpread.currentSheet()



Dipesh: /* Get and set selected cells */
2008-02-25T00:41:51Z
‎Get and set selected cells

				
				
				
				
			
			← Older revision
			Revision as of 00:41, 25 February 2008
			
Line 501:
Line 501:
  import KSpread   import KSpread
  view = KSpread.view()   view = KSpread.view()
− (x1,y1,x2,y2) = view.selection() + (x1, y1, x2, y2) = view.selection()
− view.setSelection([x1-1,y-1,x2+1,x2+1]) + view.setSelection( [x1-1, y1-1, x2+1, y2+1] )
  </code>   </code>
    





Dipesh: /* Print all values in all sheets */
2008-02-25T00:40:03Z
‎Print all values in all sheets

				
				
				
				
			
			← Older revision
			Revision as of 00:40, 25 February 2008
			
Line 457:
Line 457:
  <code python>   <code python>
  import KSpread   import KSpread
− for sheetname in KSpread.sheetNames(): + for n in KSpread.sheetNames():
−      sheet = KSpread.sheetByName(sheetname) +      sheet = KSpread.sheetByName(n)
       for row in range(1, sheet.lastRow() + 1):        for row in range(1, sheet.lastRow() + 1):
           record = []            record = []





Dipesh: /* Get and set values in a cell */
2008-02-25T00:38:30Z
‎Get and set values in a cell

				
				
				
				
			
			← Older revision
			Revision as of 00:38, 25 February 2008
			
Line 432:
Line 432:
  sheet.setText(6, 3, t1)   sheet.setText(6, 3, t1)
  # swap value of D7 and E8   # swap value of D7 and E8
− t1 = sheet.value("D7") + v1 = sheet.value("D7")
− t2 = sheet.value(8,5) + v2 = sheet.value(8,5)
− sheet.setValue("D7", t2) + sheet.setValue("D7", v2)
− sheet.setValue(8, 5, t1) + sheet.setValue(8, 5, v1)
  </code>   </code>
    





Dipesh: /* Snippets */
2008-02-25T00:32:22Z
‎Snippets

				
				
				
				
			
			← Older revision
			Revision as of 00:32, 25 February 2008
			
Line 422:
Line 422:
  ==Snippets==   ==Snippets==
    
− ===Get and set values and text in a cell=== + ===Get and set values in a cell===
−   + 
  <code python>   <code python>
  import KSpread   import KSpread
Line 439:
Line 438:
  </code>   </code>
    
− ===Translate between name and coordinates of a cells=== + ===Do something if a value in a cell changed===
  + <code python>
  + import KSpread
  + # the sheet we like to listen to
  + sheet = KSpread.view().sheet()
  + # the cells within that sheet we like to listen to
  + cellrange = "A1:F50"
  + # create the listener and connect an own handler for it
  + listener = KSpread.createListener(sheet.sheetName(), cellrange)
  + def cellChanged(column, row):
  +     t = sheet.text(column, row)
  +     if not t.endswith("test"):
  +         sheet.setText(column, row, "%s test" % t)
  + listener.connect("cellChanged(int,int)", cellChanged)
  + </code>
    
  + ===Print all values in all sheets===
  + <code python>
  + import KSpread
  + for sheetname in KSpread.sheetNames():
  +     sheet = KSpread.sheetByName(sheetname)
  +     for row in range(1, sheet.lastRow() + 1):
  +         record = []
  +         for col in range(1, sheet.lastColumn() + 1):
  +             record.append( sheet.text(col, row) )
  +         print ",".join(record)
  + </code>
  + 
  + ===Translate between name and coordinates of a cells===
  <code python>   <code python>
  import KSpread   import KSpread
Line 455:
Line 481:
    
  ===Get and set active sheet===   ===Get and set active sheet===
−  
  <code python>   <code python>
  import KSpread   import KSpread
  view = KSpread.view()   view = KSpread.view()
  + # following both calls are identical but the
  + # first one always needs a valid view while
  + # the second can be even used without view.
  print view.sheet()   print view.sheet()
  + print KSpread.currentSheet()
  + # Activate a sheet named "Sheet 2"
  view.showSheet("Sheet 2")   view.showSheet("Sheet 2")
  + # Activate the previous sheet
  view.previousSheet()   view.previousSheet()
  + # Activate the next sheet
  view.nextSheet()   view.nextSheet()
  </code>   </code>
    
  ===Get and set selected cells===   ===Get and set selected cells===
−  
  <code python>   <code python>
  import KSpread   import KSpread
Line 474:
Line 505:
  </code>   </code>
    
− ===Change the name of a sheet=== + ===Do something if the selection changed===
  + <code python>
  + import KSpread
  + view = KSpread.view()
  + def selectionChanged():
  +     # this will be called either if the sheet or
  +     # the selection within a sheet changed.
  +     print "Selection changed"
  + view.connect("selectionChanged()", selectionChanged)
  + </code>
    
  + ===Change the name of a sheet===
  <code python>   <code python>
  import KSpread   import KSpread
− sheet = KSpread.view().sheet() + sheet = KSpread.currentSheet()
  n = sheet.sheetName()   n = sheet.sheetName()
  sheet.setSheetName("%s test" % n)   sheet.setSheetName("%s test" % n)
Line 484:
Line 525:
    
  ===Do something if the name of a sheet changed===   ===Do something if the name of a sheet changed===
−  
  <code python>   <code python>
  import KSpread   import KSpread
− sheet = KSpread.view().sheet() + sheet = KSpread.currentSheet()
  name = sheet.sheetName()   name = sheet.sheetName()
  def nameChanged():   def nameChanged():
Line 496:
Line 536:
  </code>   </code>
    
− ===Do something if the selection changed=== + ===Hide or show sheets===
−   + 
  <code python>   <code python>
  import KSpread   import KSpread
− view = KSpread.view() + for n in KSpread.sheetNames():
− def selectionChanged(): +      sheet = KSpread.sheetByName(n)
−      print "Selection changed" +     if sheet.isHidden():
− view.connect("selectionChanged()", selectionChanged) +         sheet.setHidden(False)
− </code> +      else:
−   +          sheet.setHidden(True)
− ===Do something if a value in a cell changed=== + 
−   + 
− <code python> + 
− import KSpread + 
− # the sheet we like to listen to + 
− sheet = KSpread.view().sheet() + 
− # the cells within that sheet we like to listen to + 
− cellrange = "A1:F50" + 
− # create the listener and connect an own handler for it + 
− listener = KSpread.createListener(sheet.sheetName(), cellrange) + 
− def cellChanged(column, row): + 
−     t = sheet.text(column, row) + 
−      if not t.endswith("test"): + 
−          sheet.setText(column, row, "%s test" % t) + 
− listener.connect("cellChanged(int,int)", cellChanged) + 
  </code>   </code>
    
  ===Do something if a sheet got hidden/shown===   ===Do something if a sheet got hidden/shown===
−  
  <code python>   <code python>
  import KSpread   import KSpread
− sheet = KSpread.view().sheet() + sheet = KSpread.currentSheet()
  def visibleStateChanged():   def visibleStateChanged():
−      if sheet.isHidden(): +      print "Visibility of sheet changed"
−         # prevent a sheet from being hidden + 
−         sheet.setHidden(False) + 
−     else: + 
−         print "Fine, the sheet is visible" + 
  sheet.connect("showChanged()", visibleStateChanged)   sheet.connect("showChanged()", visibleStateChanged)
  sheet.connect("hideChanged()", visibleStateChanged)   sheet.connect("hideChanged()", visibleStateChanged)
  </code>   </code>



Dipesh: /* Do something if a value changed */
2008-02-25T00:06:59Z
‎Do something if a value changed

				
				
				
				
			
			← Older revision
			Revision as of 00:06, 25 February 2008
			
Line 506:
Line 506:
  </code>   </code>
    
− ===Do something if a value changed=== + ===Do something if a value in a cell changed===
    
  <code python>   <code python>

@@ Line 129: / Line 129: @@
 # to use it within KSpread
 functest1.registerFunction()
-</code>
+</syntaxhighlight>
 Now we run KSpread with the --scriptfile argument that points to the delivered [http://websvn.kde.org/trunk/koffice/kspread/plugins/scripting/scripts/functions.py?view=markup functions.py]
@@ Line 138: / Line 138: @@
 # run KSpread
 kspread --scriptfile `kde4-config --install data`/kspread/scripts/functions/functions.py
-</code>
+</syntaxhighlight>
 The screenshot below shows KSpread using the new formula function "SCRIPT_TEST1" which was added and is handled in the
@@ Line 224: / Line 224: @@
 # Set the widget for the docker
 docker.setWidget(widget)
-</code>
+</syntaxhighlight>
 Those [http://websvn.kde.org/trunk/koffice/kspread/plugins/scripting/scripts/consoledocker.py?view=markup consoledocker.py] Python script is defined within the
@@ Line 237: / Line 237: @@
          file="docker/consoledocker.py" />
 </collection>
-</code>
+</syntaxhighlight>
 See also;
@@ Line 264: / Line 264: @@
 # ...and set is as the docker's widget.
 $wdg.setWidget($label)
-</code>
+</syntaxhighlight>
 Just like at the [[Development/Tutorials/KSpread_Scripting#Python_Console|Python Console]] script above we registered the [http://websvn.kde.org/trunk/koffice/kspread/plugins/scripting/scripts/snippetsdocker.rb?view=markup snippetsdocker.rb] Ruby script in the [http://websvn.kde.org/trunk/koffice/kspread/plugins/scripting/scripts/scripts.rc?view=markup scripts.rc] file in the "docker" collection;
@@ Line 276: / Line 276: @@
          file="docker/snippetsdocker.rb" />
 </collection>
-</code>
+</syntaxhighlight>
 See also;
@@ Line 339: / Line 339: @@
      if len(record) > 0:
          csvwriter.writerow( record )
-</code>
+</syntaxhighlight>
 <!-- ####################################################################### //-->
@@ Line 353: / Line 353: @@
 # run the script
 `kde4-config --install data`/kspread/scripts/extensions/htmlexport.py
-</code>
+</syntaxhighlight>
 <!-- ####################################################################### //-->
@@ Line 402: / Line 402: @@
 if not kspread.saveUrl(savefile):
      raise "Failed to save %s" % savefile
-</code>
+</syntaxhighlight>
 <!-- ####################################################################### //-->
@@ Line 436: / Line 436: @@
 sheet.setValue("D7", v2)
 sheet.setValue(8, 5, v1)
-</code>
+</syntaxhighlight>
 ===Do something if a value in a cell changed===
@@ Line 452: / Line 452: @@
          sheet.setText(column, row, "%s test" % t)
 listener.connect("cellChanged(int,int)", cellChanged)
-</code>
+</syntaxhighlight>
 ===Print all values in all sheets===
@@ Line 464: / Line 464: @@
              record.append( sheet.text(col, row) )
          print ",".join(record)
-</code>
+</syntaxhighlight>
 ===Translate between name and coordinates of a cells===
@@ Line 478: / Line 478: @@
 # should print 2
 print sheet.cellColumn("B5")
-</code>
+</syntaxhighlight>
 ===Get and set active sheet===
@@ Line 495: / Line 495: @@
 # Activate the next sheet
 view.nextSheet()
-</code>
+</syntaxhighlight>
 ===Get and set selected cells===
@@ Line 503: / Line 503: @@
 (x1, y1, x2, y2) = view.selection()
 view.setSelection( [x1-1, y1-1, x2+1, y2+1] )
-</code>
+</syntaxhighlight>
 ===Do something if the selection changed===
@@ Line 514: / Line 514: @@
      print "Selection changed"
 view.connect("selectionChanged()", selectionChanged)
-</code>
+</syntaxhighlight>
 ===Change the name of a sheet===
@@ Line 522: / Line 522: @@
 n = sheet.sheetName()
 sheet.setSheetName("%s test" % n)
-</code>
+</syntaxhighlight>
 ===Do something if the name of a sheet changed===
@@ Line 534: / Line 534: @@
      print "name after: %s" % name
 view.connect("nameChanged()", nameChanged)
-</code>
+</syntaxhighlight>
 ===Hide or show sheets===
@@ Line 545: / Line 545: @@
      else:
          sheet.setHidden(True)
-</code>
+</syntaxhighlight>
 ===Do something if a sheet got hidden/shown===
@@ Line 555: / Line 555: @@
 sheet.connect("showChanged()", visibleStateChanged)
 sheet.connect("hideChanged()", visibleStateChanged)
-</code>
+</syntaxhighlight>