Development/Tutorials/KWord Scripting - Revision history

Neverendingo: Text replace - "" to ""

2011-06-29T20:52:35Z

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

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


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

				
				
				
				
			
			← Older revision
			Revision as of 20:34, 29 June 2011
			
Line 25:
Line 25:
    
  Following Python script demonstrates how to load and save files;   Following Python script demonstrates how to load and save files;
− <code python> + <syntaxhighlight lang="python">
  import KWord   import KWord
  KWord.document().openURL("/home/myuser/myDoc.odt")   KWord.document().openURL("/home/myuser/myDoc.odt")
Line 38:
Line 38:
  The [http://websvn.kde.org/trunk/koffice/kword/plugins/scripting/scripts/sample_importfile.py?view=markup sample_importfile.py] Python script implements import of content from a text or html file.   The [http://websvn.kde.org/trunk/koffice/kword/plugins/scripting/scripts/sample_importfile.py?view=markup sample_importfile.py] Python script implements import of content from a text or html file.
    
− <code python> + <syntaxhighlight lang="python">
  import KWord   import KWord
  doc = KWord.mainFrameSet().document()   doc = KWord.mainFrameSet().document()
Line 49:
Line 49:
  The [http://websvn.kde.org/trunk/koffice/kword/plugins/scripting/scripts/sample_exportfile.py?view=markup sample_exportfile.py] Python script implements export of content to a text or html file.   The [http://websvn.kde.org/trunk/koffice/kword/plugins/scripting/scripts/sample_exportfile.py?view=markup sample_exportfile.py] Python script implements export of content to a text or html file.
    
− <code python> + <syntaxhighlight lang="python">
  import KWord   import KWord
  doc = KWord.mainFrameSet().document()   doc = KWord.mainFrameSet().document()
Line 61:
Line 61:
    
  The following python script adds a polygon shape and then prints the name and the ID of each shape.   The following python script adds a polygon shape and then prints the name and the ID of each shape.
− <code python> + <syntaxhighlight lang="python">
  import KWord   import KWord
  KWord.addFrame("mypoly", "KoRegularPolygonShape")   KWord.addFrame("mypoly", "KoRegularPolygonShape")
Line 71:
Line 71:
  The [http://websvn.kde.org/trunk/koffice/kword/plugins/scripting/scripts/sample_insertshape.py?view=markup sample_insertshape.py] Python script implements inserting of a shape into the document.   The [http://websvn.kde.org/trunk/koffice/kword/plugins/scripting/scripts/sample_insertshape.py?view=markup sample_insertshape.py] Python script implements inserting of a shape into the document.
    
− <code python> + <syntaxhighlight lang="python">
  import KWord   import KWord
  textshape = KWord.addTextFrame("MyTextShape")   textshape = KWord.addTextFrame("MyTextShape")
Line 79:
Line 79:
  The [http://websvn.kde.org/trunk/koffice/kword/plugins/scripting/scripts/sample_allshapes.py?view=markup sample_allshapes.py] Python script just adds all shapes into the document.   The [http://websvn.kde.org/trunk/koffice/kword/plugins/scripting/scripts/sample_allshapes.py?view=markup sample_allshapes.py] Python script just adds all shapes into the document.
    
− <code python> + <syntaxhighlight lang="python">
  import KWord   import KWord
  for shapeId in KWord.shapeKeys():   for shapeId in KWord.shapeKeys():
Line 94:
Line 94:
    
  The following python sample adds some text at the end of the main framesets document.   The following python sample adds some text at the end of the main framesets document.
− <code python> + <syntaxhighlight lang="python">
  import KWord   import KWord
  doc = KWord.mainFrameSet().document()   doc = KWord.mainFrameSet().document()
Line 102:
Line 102:
    
  This python sample adds some text and sets the page header and the page footer.   This python sample adds some text and sets the page header and the page footer.
− <code python> + <syntaxhighlight lang="python">
  import KWord   import KWord
  doc = KWord.mainFrameSet().document()   doc = KWord.mainFrameSet().document()
Line 111:
Line 111:
    
  Python sample that prints the url and some metainformations of the document.   Python sample that prints the url and some metainformations of the document.
− <code python> + <syntaxhighlight lang="python">
  import KWord   import KWord
  print KWord.document().url()   print KWord.document().url()
Line 128:
Line 128:
  The following python sample does demonstrate how to print the element-names of all xml-files that are within the KWord KoStore backend (see [http://websvn.kde.org/trunk/koffice/libs/kokross/KoScriptingOdf.h?view=markup KoScriptingOdf.h]) for our current document.   The following python sample does demonstrate how to print the element-names of all xml-files that are within the KWord KoStore backend (see [http://websvn.kde.org/trunk/koffice/libs/kokross/KoScriptingOdf.h?view=markup KoScriptingOdf.h]) for our current document.
    
− <code python> + <syntaxhighlight lang="python">
  import KWord   import KWord
  store = KWord.store()   store = KWord.store()
Line 152:
Line 152:
  The [http://websvn.kde.org/trunk/koffice/kword/plugins/scripting/scripts/sample_variables.py?view=markup sample_variables.py] Python script demonstrates how to handle variables.   The [http://websvn.kde.org/trunk/koffice/kword/plugins/scripting/scripts/sample_variables.py?view=markup sample_variables.py] Python script demonstrates how to handle variables.
    
− <code python> + <syntaxhighlight lang="python">
  import KWord   import KWord
  doc = KWord.mainFrameSet().document()   doc = KWord.mainFrameSet().document()
Line 167:
Line 167:
  The [http://websvn.kde.org/trunk/koffice/kword/plugins/scripting/scripts/sample_actions.py?view=markup sample_actions.py] Python script demonstrates usage of actions.   The [http://websvn.kde.org/trunk/koffice/kword/plugins/scripting/scripts/sample_actions.py?view=markup sample_actions.py] Python script demonstrates usage of actions.
    
− <code python> + <syntaxhighlight lang="python">
  import KWord   import KWord
  KWord.shell().slotFileNew()   KWord.shell().slotFileNew()
Line 175:
Line 175:
  The [http://websvn.kde.org/trunk/koffice/kword/plugins/scripting/scripts/sample_toolactions.py?view=markup sample_toolactions.py] Python script demonstrates how to trigger actions the current tool provides.   The [http://websvn.kde.org/trunk/koffice/kword/plugins/scripting/scripts/sample_toolactions.py?view=markup sample_toolactions.py] Python script demonstrates how to trigger actions the current tool provides.
    
− <code python> + <syntaxhighlight lang="python">
  import KWord   import KWord
  tool = KWord.tool()   tool = KWord.tool()
Line 185:
Line 185:
  The [http://websvn.kde.org/trunk/koffice/kword/plugins/scripting/scripts/sample_progressbar.py?view=markup sample_progressbar.py] Python script demonstrates how to use the progressbar.   The [http://websvn.kde.org/trunk/koffice/kword/plugins/scripting/scripts/sample_progressbar.py?view=markup sample_progressbar.py] Python script demonstrates how to use the progressbar.
    
− <code python> + <syntaxhighlight lang="python">
  import KWord   import KWord
  for i in range(1,101):   for i in range(1,101):
Line 194:
Line 194:
  The [http://websvn.kde.org/trunk/koffice/kword/plugins/scripting/scripts/onlinehelp.py?view=markup onlinehelp.py] Python script uses the KHTML Part to display the KWord Scripting online help.   The [http://websvn.kde.org/trunk/koffice/kword/plugins/scripting/scripts/onlinehelp.py?view=markup onlinehelp.py] Python script uses the KHTML Part to display the KWord Scripting online help.
    
− <code python> + <syntaxhighlight lang="python">
  import Kross   import Kross
  forms = Kross.module("forms")   forms = Kross.module("forms")



Thomas Zander: Update to get the auto-created docs from koffice.org
2009-04-20T10:08:11Z
Update to get the auto-created docs from koffice.org

				
				
				
				
			
			← Older revision
			Revision as of 10:08, 20 April 2009
			
Line 16:
Line 16:
  ===Scripting Handbook===   ===Scripting Handbook===
    
− The [http://kross.dipe.org/dox/kword.html KWord Scripting Handbook] ([http://kross.dipe.org/dox/kword.pdf PDF]) contains a full reference of the functionality accessible from within the scripting backends. + The [http://www.koffice.org/developer/apidocs/kword-plugins-scripting/index.html KWord Scripting Handbook] contains a full reference of the functionality accessible from within the scripting backends.
    
  The Handbook is generated from the sourcecode using doxygen and KWord's [[Development/Tutorials/KWord_Scripting#Import_combined_Doxygen_XML_File|Import Doxygen XML File]] python script.   The Handbook is generated from the sourcecode using doxygen and KWord's [[Development/Tutorials/KWord_Scripting#Import_combined_Doxygen_XML_File|Import Doxygen XML File]] python script.





Zander: /* Intro */
2009-04-17T08:59:57Z
‎Intro

				
				
				
				
			
			← Older revision
			Revision as of 08:59, 17 April 2009
			
Line 1:
Line 1:
  ==Intro==   ==Intro==
    
− KWord uses [[Development/Languages/Kross|Kross]] to provide scripting with [http://www.python.org/ Python], [http://www.ruby-lang.org/ Ruby] and [http://xmelegance.org/kjsembed KDE JavaScript]. + KWord2.0 uses [[Development/Languages/Kross|Kross]] to provide scripting with [http://www.python.org/ Python], [http://www.ruby-lang.org/ Ruby] and [http://xmelegance.org/kjsembed KDE JavaScript].
  +  
  + With the 2.0 release the scripts Application Programming Interface (API) is unsupported and unfinished and known to change. Use the API at your own risk! When the API is stable you can depend on future versions not breaking your scripts, this support is not present in the 2.0 release of KWord.
    
  ===The Scripting Plugin===   ===The Scripting Plugin===





Jstaniek: /* Intro */
2009-03-07T17:23:12Z
‎Intro

				
				
				
				
			
			← Older revision
			Revision as of 17:23, 7 March 2009
			
Line 1:
Line 1:
  ==Intro==   ==Intro==
    
− KWord uses [http://wiki.koffice.org/index.php?title=Kross Kross] to provide scripting with [http://www.python.org/ Python], [http://www.ruby-lang.org/ Ruby] and [http://xmelegance.org/kjsembed KDE JavaScript]. + KWord uses [[Development/Languages/Kross|Kross]] to provide scripting with [http://www.python.org/ Python], [http://www.ruby-lang.org/ Ruby] and [http://xmelegance.org/kjsembed KDE JavaScript].
    
  ===The Scripting Plugin===   ===The Scripting Plugin===



Dipesh at 01:00, 23 August 2007
2007-08-23T01:00:24Z


				
				
				
				
			
			← Older revision
			Revision as of 01:00, 23 August 2007
			
Line 121:
Line 121:
    
  The [http://websvn.kde.org/trunk/koffice/kword/plugins/scripting/scripts/sample_tables.py?view=markup sample_tables.py] Python script demonstrates how to deal with tables.   The [http://websvn.kde.org/trunk/koffice/kword/plugins/scripting/scripts/sample_tables.py?view=markup sample_tables.py] Python script demonstrates how to deal with tables.
  + 
  + === KoStore and XML ===
  + 
  + The following python sample does demonstrate how to print the element-names of all xml-files that are within the KWord KoStore backend (see [http://websvn.kde.org/trunk/koffice/libs/kokross/KoScriptingOdf.h?view=markup KoScriptingOdf.h]) for our current document.
  + 
  + <code python>
  + import KWord
  + store = KWord.store()
  + reader = store.open("META-INF/manifest.xml")
  + if not reader:
  +     raise "Failed to read the mainfest"
  + paths = []
  + for i in range( reader.count() ):
  +     if reader.type(i) == "text/xml":
  +         paths.append( reader.path(i) )
  + for p in paths:
  +     reader = store.open(p)
  +     if not reader:
  +         raise "Failed to read %s" % p
  +     def onElement():
  +         print reader.name()
  +     reader.connect("onElement()", onElement)
  +     reader.start()
  + </code>
    
  === Variables ===   === Variables ===
Line 225:
Line 249:
  The python script [http://websvn.kde.org/trunk/koffice/kword/plugins/scripting/scripts/xmlviewer.py?view=markup xmlviewer.py] to view the ISO OpenDocumentText XML representation of the current document displayed in KWord.   The python script [http://websvn.kde.org/trunk/koffice/kword/plugins/scripting/scripts/xmlviewer.py?view=markup xmlviewer.py] to view the ISO OpenDocumentText XML representation of the current document displayed in KWord.
    
− The following python sample does demonstrate how to print the element-names of all xml-files that are within the KWord KoStore backend (see [http://websvn.kde.org/trunk/koffice/libs/kokross/KoScriptingOdf.h?view=markup KoScriptingOdf.h]) for our current document. + The XML Viewer does also allow to open the XML of the current document with an external application like KWrite or KXMLEditor. The "Compare..." button enables to compare the current XML with the XML of another ODT file.
− <code python> +  
− import KWord + [[Image:kwordxmlviewer.jpg]]
− store = KWord.store() + 
− reader = store.open("META-INF/manifest.xml") + 
− if not reader: + 
−     raise "Failed to read the mainfest" + 
− paths = [] + 
− for i in range( reader.count() ): + 
−     if reader.type(i) == "text/xml": + 
−         paths.append( reader.path(i) ) + 
− for p in paths: + 
−     reader = store.open(p) + 
−     if not reader: + 
−         raise "Failed to read %s" % p + 
−     def onElement(): + 
−         print reader.name() + 
−     reader.connect("onElement()", onElement) + 
−     reader.start() + 
− </code> + 
    
  === Document Structure Viewer ===   === Document Structure Viewer ===



Dipesh at 19:36, 20 August 2007
2007-08-20T19:36:00Z


				
				
				
				
			
			← Older revision
			Revision as of 19:36, 20 August 2007
			
Line 166:
Line 166:
  </code>   </code>
    
− The [http://websvn.kde.org/trunk/koffice/kword/plugins/scripting/scripts/sample_onlinehelp.py?view=markup sample_onlinehelp.py] Python script uses the KHTML Part to display the KWord Scripting online help. + The [http://websvn.kde.org/trunk/koffice/kword/plugins/scripting/scripts/onlinehelp.py?view=markup onlinehelp.py] Python script uses the KHTML Part to display the KWord Scripting online help.
    
  <code python>   <code python>
Line 220:
Line 220:
    
  The python script [http://websvn.kde.org/trunk/koffice/kword/plugins/scripting/scripts/exportfile.py?view=markup exportfile.py] allows to export content to text- or html-files.   The python script [http://websvn.kde.org/trunk/koffice/kword/plugins/scripting/scripts/exportfile.py?view=markup exportfile.py] allows to export content to text- or html-files.
  + 
  + === XML Viewer ===
  + 
  + The python script [http://websvn.kde.org/trunk/koffice/kword/plugins/scripting/scripts/xmlviewer.py?view=markup xmlviewer.py] to view the ISO OpenDocumentText XML representation of the current document displayed in KWord.
  + 
  + The following python sample does demonstrate how to print the element-names of all xml-files that are within the KWord KoStore backend (see [http://websvn.kde.org/trunk/koffice/libs/kokross/KoScriptingOdf.h?view=markup KoScriptingOdf.h]) for our current document.
  + <code python>
  + import KWord
  + store = KWord.store()
  + reader = store.open("META-INF/manifest.xml")
  + if not reader:
  +     raise "Failed to read the mainfest"
  + paths = []
  + for i in range( reader.count() ):
  +     if reader.type(i) == "text/xml":
  +         paths.append( reader.path(i) )
  + for p in paths:
  +     reader = store.open(p)
  +     if not reader:
  +         raise "Failed to read %s" % p
  +     def onElement():
  +         print reader.name()
  +     reader.connect("onElement()", onElement)
  +     reader.start()
  + </code>
    
  === Document Structure Viewer ===   === Document Structure Viewer ===
    
− The [http://websvn.kde.org/trunk/koffice/kword/plugins/scripting/scripts/sample_doctree.rb?view=markup sample_doctree.rb] QtRuby script implement a document structur viewer. + The [http://websvn.kde.org/trunk/koffice/kword/plugins/scripting/scripts/doctree.rb?view=markup doctree.rb] QtRuby script implement a document structur viewer.
    
  The viewer displays the framesets, frames, documents and there objects as tree where each node may provide additional functionality like a collection of properties, text or styles.   The viewer displays the framesets, frames, documents and there objects as tree where each node may provide additional functionality like a collection of properties, text or styles.
    
  [[Image:kwordscriptingdoctree.jpg]]   [[Image:kwordscriptingdoctree.jpg]]





Dipesh: /* Scripting Handbook */
2007-08-11T22:50:45Z
‎Scripting Handbook

				
				
				
				
			
			← Older revision
			Revision as of 22:50, 11 August 2007
			
Line 14:
Line 14:
  ===Scripting Handbook===   ===Scripting Handbook===
    
− The [http://kross.dipe.org/dox/kword.html KWord Scripting Handbook] contains a full reference of all objects and methods accessible from within the scripting backends. + The [http://kross.dipe.org/dox/kword.html KWord Scripting Handbook] ([http://kross.dipe.org/dox/kword.pdf PDF]) contains a full reference of the functionality accessible from within the scripting backends.
    
− The Handbook is generated from the sourcecode using doxygen and the [http://websvn.kde.org/trunk/KDE/kdelibs/kross/docs/doxy2doc.py?view=markup doxy2doc.py] Python script as postprocessor to create visible output from the by doxygen produced XML files. + The Handbook is generated from the sourcecode using doxygen and KWord's [[Development/Tutorials/KWord_Scripting#Import_combined_Doxygen_XML_File|Import Doxygen XML File]] python script.
    
  ==Samples==   ==Samples==





Dipesh at 21:28, 10 August 2007
2007-08-10T21:28:56Z


				
				
				
				
			
			← Older revision
			Revision as of 21:28, 10 August 2007
			
Line 55:
Line 55:
  f.close()   f.close()
  </code>   </code>
−  
− === Document Structure Viewer ===  
−  
− The [http://websvn.kde.org/trunk/koffice/kword/plugins/scripting/scripts/sample_doctree.rb?view=markup sample_doctree.rb] QtRuby script implement a document structur viewer.  
−  
− The viewer displays the framesets, frames, documents and there objects as tree where each node may provide additional functionality like a collection of properties, text or styles.  
−  
− [[Image:kwordscriptingdoctree.jpg]]  
    
  === Framesets, Frames and Shapes ===   === Framesets, Frames and Shapes ===
Line 228:
Line 220:
    
  The python script [http://websvn.kde.org/trunk/koffice/kword/plugins/scripting/scripts/exportfile.py?view=markup exportfile.py] allows to export content to text- or html-files.   The python script [http://websvn.kde.org/trunk/koffice/kword/plugins/scripting/scripts/exportfile.py?view=markup exportfile.py] allows to export content to text- or html-files.
  + 
  + === Document Structure Viewer ===
  + 
  + The [http://websvn.kde.org/trunk/koffice/kword/plugins/scripting/scripts/sample_doctree.rb?view=markup sample_doctree.rb] QtRuby script implement a document structur viewer.
  + 
  + The viewer displays the framesets, frames, documents and there objects as tree where each node may provide additional functionality like a collection of properties, text or styles.
  + 
  + [[Image:kwordscriptingdoctree.jpg]]





Dipesh: /* Import combined Doxygen XML File */
2007-08-10T21:27:24Z
‎Import combined Doxygen XML File

				
				
				
				
			
			← Older revision
			Revision as of 21:27, 10 August 2007
			
Line 202:
Line 202:
       doxygen kspreadscripting.doxyfile        doxygen kspreadscripting.doxyfile
       cd xml        cd xml
−      xsltproc combine.xslt index.xml | importdoxyxml.py ../kspread.html +      xsltproc combine.xslt index.xml | importdoxyxml.py kspread.html
    
  You are also able to just generate a combined doxygen XML file with;   You are also able to just generate a combined doxygen XML file with;

@@ Line 30: / Line 30: @@
 KWord.document().saveAs("/home/myuser/myDocCopy.odt")
 KWord.document().saveAs("/home/myuser/myDocAsText.txt")
-</code>
+</syntaxhighlight>
 All slots and signals within the [http://websvn.kde.org/trunk/koffice/libs/kofficecore/KoDocumentAdaptor.h?view=markup KoDocumentAdaptor] are accessible as KWord.document().
@@ Line 45: / Line 45: @@
 #doc.setHtml( ' '.join(f.readlines()) )
 f.close()
-</code>
+</syntaxhighlight>
 The [http://websvn.kde.org/trunk/koffice/kword/plugins/scripting/scripts/sample_exportfile.py?view=markup sample_exportfile.py] Python script implements export of content to a text or html file.
@@ Line 56: / Line 56: @@
 #f.write( doc.toHtml() )
 f.close()
-</code>
+</syntaxhighlight>
 === Framesets, Frames and Shapes ===
@@ Line 67: / Line 67: @@
      f = KWord.frame(i)
      print "%s %s" % (f.frameSet().name(),f.shapeId())
-</code>
+</syntaxhighlight>
 The [http://websvn.kde.org/trunk/koffice/kword/plugins/scripting/scripts/sample_insertshape.py?view=markup sample_insertshape.py] Python script implements inserting of a shape into the document.
@@ Line 75: / Line 75: @@
 textshape = KWord.addTextFrame("MyTextShape")
 textshape.document().setText("Some text")
-</code>
+</syntaxhighlight>
 The [http://websvn.kde.org/trunk/koffice/kword/plugins/scripting/scripts/sample_allshapes.py?view=markup sample_allshapes.py] Python script just adds all shapes into the document.
@@ Line 87: / Line 87: @@
          frame.setPosition(200, 50)
          frame.resize(160, 80)
-</code>
+</syntaxhighlight>
 === Text content ===
@@ Line 99: / Line 99: @@
 cursor = doc.rootFrame().lastCursorPosition()
 cursor.insertHtml("<b>Some text</b>")
-</code>
+</syntaxhighlight>
 This python sample adds some text and sets the page header and the page footer.
@@ Line 108: / Line 108: @@
 KWord.firstPageHeaderFrameSet().document().setText("Header")
 KWord.firstPageFooterFrameSet().document().setText("Footer")
-</code>
+</syntaxhighlight>
 Python sample that prints the url and some metainformations of the document.
@@ Line 116: / Line 116: @@
 print KWord.document().documentInfoTitle()
 print KWord.document().documentInfoAuthorName()
-</code>
+</syntaxhighlight>
 The [http://websvn.kde.org/trunk/koffice/kword/plugins/scripting/scripts/sample_lists_html.py?view=markup sample_lists_html.py] Python script demonstrates how to create lists with HTML.
@@ Line 146: / Line 146: @@
      reader.connect("onElement()", onElement)
      reader.start()
-</code>
+</syntaxhighlight>
 === Variables ===
@@ Line 157: / Line 157: @@
 for v in doc.variableNames():
      print "name=%s value=%s" % (v, doc.variableValue(v))
-</code>
+</syntaxhighlight>
 The [http://websvn.kde.org/trunk/koffice/kword/plugins/scripting/scripts/variable_readfile.py?view=markup variable_readfile.py] Python script to read a variable from a file.
@@ Line 171: / Line 171: @@
 KWord.shell().slotFileNew()
 KWord.mainWindow().setCaption("My Caption")
-</code>
+</syntaxhighlight>
 The [http://websvn.kde.org/trunk/koffice/kword/plugins/scripting/scripts/sample_toolactions.py?view=markup sample_toolactions.py] Python script demonstrates how to trigger actions the current tool provides.
@@ Line 181: / Line 181: @@
      print "%s: %s" % (n, tool.actionText(n))
      tool.triggerAction(n)
-</code>
+</syntaxhighlight>
 The [http://websvn.kde.org/trunk/koffice/kword/plugins/scripting/scripts/sample_progressbar.py?view=markup sample_progressbar.py] Python script demonstrates how to use the progressbar.
@@ Line 190: / Line 190: @@
      KWord.shell().slotProgress(i)
 KWord.shell().slotProgress(-1)
-</code>
+</syntaxhighlight>
 The [http://websvn.kde.org/trunk/koffice/kword/plugins/scripting/scripts/onlinehelp.py?view=markup onlinehelp.py] Python script uses the KHTML Part to display the KWord Scripting online help.
@@ Line 202: / Line 202: @@
 part = forms.loadPart(page, "libkhtmlpart", url)
 dialog.exec_loop()
-</code>
+</syntaxhighlight>
 == Scripts ==