Development/Tutorials/Kross/Script-Actions - Revision history

Neverendingo: /* The KParts Plugin class */

2011-06-29T19:06:34Z

‎The KParts Plugin class

Neverendingo: /* The KParts Plugin class */

2011-06-29T19:06:03Z

‎The KParts Plugin class

Neverendingo: Text replace - "" to ""

2011-06-29T18:42:04Z

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

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


2011-06-29T18:38:18Z
Text replace - "<code xml>" to "<syntaxhighlight lang="xml">"

				
				
				
				
			
			← Older revision
			Revision as of 18:38, 29 June 2011
			
Line 17:
Line 17:
  An example of such Kross rc file could be:   An example of such Kross rc file could be:
    
− <code xml> + <syntaxhighlight lang="xml">
  <!DOCTYPE KrossScripting SYSTEM "kpartgui.dtd">   <!DOCTYPE KrossScripting SYSTEM "kpartgui.dtd">
  <KrossScripting>   <KrossScripting>
Line 148:
Line 148:
  Suggestion on how to use the edit and reset script actions (respective slots provided by Kross::ScriptingPlugin class):   Suggestion on how to use the edit and reset script actions (respective slots provided by Kross::ScriptingPlugin class):
    
− <code xml> + <syntaxhighlight lang="xml">
  <!DOCTYPE kpartgui SYSTEM "kpartgui.dtd">   <!DOCTYPE kpartgui SYSTEM "kpartgui.dtd">
  <kpartgui name="MyApplicationPluginScripting" library="krossmodulemyapplication" version="1">   <kpartgui name="MyApplicationPluginScripting" library="krossmodulemyapplication" version="1">



Shaforostoff: /* The code */
2009-05-03T22:18:52Z
‎The code

				
				
				
				
			
			← Older revision
			Revision as of 22:18, 3 May 2009
			
Line 21:
Line 21:
  <KrossScripting>   <KrossScripting>
       <collection name="tools" text="Tools">        <collection name="tools" text="Tools">
−          <script +          <script text="Dummy Script" comment="Dummy Script"
               name="dummy_script"                name="dummy_script"
−             text="Dummy Script"  
−             comment="Dummy Script"  
               interpreter="python"                interpreter="python"
               file="dummy_script.py" />                file="dummy_script.py" />
Line 32:
Line 30:
    
  The effect of such description will be the creation of a new menu item called "Dummy Script" in the "Tools" menu. The action associated to the new menu item will execute the script defined in the "file" path.   The effect of such description will be the creation of a new menu item called "Dummy Script" in the "Tools" menu. The action associated to the new menu item will execute the script defined in the "file" path.
  + 
  + Placing text and comment attributes on the same line with tag name is important for extractattr script that extracts strings for i18n.
    
  Kross rc files are searched in the appdata "scripts" subdirectory, e.g.:   Kross rc files are searched in the appdata "scripts" subdirectory, e.g.:





Shaforostoff: /* The code */
2009-05-03T22:17:02Z
‎The code

				
				
				
				
			
			← Older revision
			Revision as of 22:17, 3 May 2009
			
Line 18:
Line 18:
    
  <code xml>   <code xml>
  + <!DOCTYPE KrossScripting SYSTEM "kpartgui.dtd">
  <KrossScripting>   <KrossScripting>
       <collection name="tools" text="Tools">        <collection name="tools" text="Tools">



Tampakrap: now it's possible to add objects which will propagate into all the actions
2008-06-05T16:51:21Z
now it's possible to add objects which will propagate into all the actions

				
				
				
				
			
			← Older revision
			Revision as of 16:51, 5 June 2008
			
Line 98:
Line 98:
  {   {
       d->module = new ScriptingModule(parent);        d->module = new ScriptingModule(parent);
  +     addObject(d->module, "MyApplication");
    
       setComponentData(ScriptingPart::componentData());        setComponentData(ScriptingPart::componentData());



Mojo risin at 18:14, 19 March 2008
2008-03-19T18:14:40Z


				
				
				
				
			
			← Older revision
			Revision as of 18:14, 19 March 2008
			
Line 3:
Line 3:
  This tutorial uses the script plugin technique explained in [http://techbase.kde.org/index.php?title=Development/Tutorials/Kross/Introduction#The_Module_plugins The Module Plugins] and explains how to code your application in order to easily add new script actions into menus. Two typical scenarios are:   This tutorial uses the script plugin technique explained in [http://techbase.kde.org/index.php?title=Development/Tutorials/Kross/Introduction#The_Module_plugins The Module Plugins] and explains how to code your application in order to easily add new script actions into menus. Two typical scenarios are:
    
− - scripts shipped by default by the application developer + - scripts shipped by default by the application developer<br>
  - custom scripts added by the user   - custom scripts added by the user
    
Line 34:
Line 34:
  Kross rc files are searched in the appdata "scripts" subdirectory, e.g.:   Kross rc files are searched in the appdata "scripts" subdirectory, e.g.:
    
− $KDEDIR/share/apps/myapplication/scripts/*.rc + $KDEDIR/share/apps/myapplication/scripts/*.rc<br>
  $KDEHOME/share/apps/myapplication/scripts/*.rc   $KDEHOME/share/apps/myapplication/scripts/*.rc
    
Line 123:
Line 123:
  }   }
  </code>   </code>
  + 
    
    





Mojo risin at 18:10, 19 March 2008
2008-03-19T18:10:26Z


				
				
				
				
			
			← Older revision
			Revision as of 18:10, 19 March 2008
			
Line 123:
Line 123:
  }   }
  </code>   </code>
  + 
    
  Kross::ScriptingPlugin have two additional slots that can be useful for applications to use:   Kross::ScriptingPlugin have two additional slots that can be useful for applications to use:
Line 142:
Line 143:
  ===The KPart plugin rc file===   ===The KPart plugin rc file===
    
− Suggestion on how to use the edit and reset script action provided by Kross::ScriptingPlugin class: + Suggestion on how to use the edit and reset script actions (respective slots provided by Kross::ScriptingPlugin class):
    
  <code xml>   <code xml>



Mojo risin: New page: ==Introduction==  This tutorial uses the script plugin technique explained in [http://techbase.kde.org/index.php?title=Development/Tutorials/Kross/Introduction#The_Module_plugins The Modul...
2008-03-19T18:05:58Z
New page: ==Introduction==  This tutorial uses the script plugin technique explained in [http://techbase.kde.org/index.php?title=Development/Tutorials/Kross/Introduction#The_Module_plugins The Modul...
New page
==Introduction==



This tutorial uses the script plugin technique explained in [http://techbase.kde.org/index.php?title=Development/Tutorials/Kross/Introduction#The_Module_plugins The Module Plugins] and explains how to code your application in order to easily add new script actions into menus. Two typical scenarios are:



- scripts shipped by default by the application developer

- custom scripts added by the user



This facility is targeted for both cases.



See also...

* [[Development/Tutorials/Kross/Introduction#The_Module_plugins|The Module Plugins]]



==The code==



The client Part Plugin class should extend Kross::ScriptingPlugin which will automatically load script actions stored in Kross rc files.



An example of such Kross rc file could be:



<code xml>

<KrossScripting>

    <collection name="tools" text="Tools">

        <script

            name="dummy_script"

            text="Dummy Script"

            comment="Dummy Script"

            interpreter="python"

            file="dummy_script.py" />

    </collection>

</KrossScripting>

</code>



The effect of such description will be the creation of a new menu item called "Dummy Script" in the "Tools" menu. The action associated to the new menu item will execute the script defined in the "file" path.



Kross rc files are searched in the appdata "scripts" subdirectory, e.g.:



$KDEDIR/share/apps/myapplication/scripts/*.rc

$KDEHOME/share/apps/myapplication/scripts/*.rc



It will be explained later how can a final user override the actions found in the default rc files.



===The KParts Plugin class===



In this example we show the scripting plugin class which inherits a Kross::ScriptingPlugin.



Header:



<code cppqt>

#include <kross/ui/plugin.h>



class ScriptingModule;



class ScriptingPart : public Kross::ScriptingPlugin

{

public:

    ScriptingPart(QObject* parent, const QStringList& list);

    ~ScriptingPart();



    ScriptingModule* module() const;



private:

    void initActions();



private:

    Q_DISABLE_COPY(ScriptingPart)



    class Private;

    Private* const d;

};

</code>





Implementation:



<code cppqt>

#include "scriptingpart.h"



#include <kgenericfactory.h>

#include <kstandarddirs.h>

#include <kactioncollection.h>

#include <kcmdlineargs.h>

#include <kurl.h>

#include <klocale.h>



#include "scriptingmodule.h"



typedef KGenericFactory<ScriptingPart> MyApplicationScriptingFactory;

K_EXPORT_COMPONENT_FACTORY(krossmodulemyapplication, MyApplicationScriptingFactory("krossmodulemyapplication"))



class ScriptingPart::Private

{

public:

    QPointer<ScriptingModule> module;

};



ScriptingPart::ScriptingPart(QObject* parent, const QStringList&)

    : Kross::ScriptingPlugin(parent)

    , d(new Private())

{

    d->module = new ScriptingModule(parent);



    setComponentData(ScriptingPart::componentData());

    setXMLFile(KStandardDirs::locate("data", "myapplication/kpartplugins/scripting.rc"), true);

    kDebug(23100) <<"Scripting plugin. Class:" << metaObject()->className() 

        <<", Parent:" << parent->metaObject()->className();



    initActions();

}



ScriptingPart::~ScriptingPart()

{

    delete d;

}



void ScriptingPart::initActions()

{

    KAction* action  = new KAction(i18n("Edit Script Actions..."), this);

    actionCollection()->addAction("edit_script_actions", action);

    connect(action, SIGNAL(triggered(bool)), this, SLOT(slotEditScriptActions()));



    action  = new KAction(i18n("Reset Script Actions..."), this);

    actionCollection()->addAction("reset_script_actions", action);

    connect(action, SIGNAL(triggered(bool)), this, SLOT(slotResetScriptActions()));

}

</code>



Kross::ScriptingPlugin have two additional slots that can be useful for applications to use:



<code cppqt>

    /**

     * This slot will open/create a scriptactions.rc file at $KDEHOME/share/apps/application/scripts/

     * which will override other kross rc files. This allows a user to extend existing menus with new actions.

    */

    virtual void slotEditScriptActions();



    /**

     * Deletes the user rc file, which has the effect of falling back to the default script actions (if any).

    */

    virtual void slotResetScriptActions();

</code>





===The KPart plugin rc file===



Suggestion on how to use the edit and reset script action provided by Kross::ScriptingPlugin class:



<code xml>

<!DOCTYPE kpartgui SYSTEM "kpartgui.dtd">

<kpartgui name="MyApplicationPluginScripting" library="krossmodulemyapplication" version="1">

<MenuBar>

    <Menu name="tools"><text>&amp;Tools</text>

        <Separator/>

        <Action name="edit_script_actions"/>

        <Action name="reset_script_actions"/>

        <Separator/>

    </Menu>

</MenuBar>

</code>

@@ Line 27: / Line 27: @@
      </collection>
 </KrossScripting>
-</code>
+</syntaxhighlight>
 The effect of such description will be the creation of a new menu item called "Dummy Script" in the "Tools" menu. The action associated to the new menu item will execute the script defined in the "file" path.
@@ Line 68: / Line 68: @@
      Private* const d;
 };
-</code>
+</syntaxhighlight>
@@ Line 124: / Line 124: @@
      connect(action, SIGNAL(triggered(bool)), this, SLOT(slotResetScriptActions()));
+}
-</code>
+</syntaxhighlight>
@@ Line 141: / Line 141: @@
      */
      virtual void slotResetScriptActions();
-</code>
+</syntaxhighlight>
@@ Line 159: / Line 159: @@
      </Menu>
 </MenuBar>
-</code>
+</syntaxhighlight>