[prev in list] [next in list] [prev in thread] [next in thread]
List: kde-commits
Subject: koffice/libs/kokross
From: Sebastian Sauer <mail () dipe ! org>
Date: 2007-05-31 23:29:56
Message-ID: 1180654196.788451.10588.nullmailer () svn ! kde ! org
[Download RAW message or body]
SVN commit 670292 by sebsauer:
dox++
M +7 -6 KoScriptingDocker.cpp
M +62 -7 KoScriptingDocker.h
M +22 -2 KoScriptingGuiClient.h
--- trunk/koffice/libs/kokross/KoScriptingDocker.cpp #670291:670292
@@ -18,6 +18,7 @@
***************************************************************************/
#include "KoScriptingDocker.h"
+#include "KoScriptingGuiClient.h"
#include <QToolBar>
#include <QBoxLayout>
@@ -43,10 +44,10 @@
{
public:
QWidget* parent;
- Kross::GUIClient* guiclient;
+ KoScriptingGuiClient* guiclient;
};
-KoScriptingDockerFactory::KoScriptingDockerFactory(QWidget* parent, Kross::GUIClient* guiclient)
+KoScriptingDockerFactory::KoScriptingDockerFactory(QWidget* parent, KoScriptingGuiClient* guiclient)
: KoDockFactory()
, d(new Private())
{
@@ -59,7 +60,7 @@
delete d;
}
-Kross::GUIClient* KoScriptingDockerFactory::guiClient() const
+KoScriptingGuiClient* KoScriptingDockerFactory::guiClient() const
{
return d->guiclient;
}
@@ -88,13 +89,13 @@
class KoScriptingDocker::Private
{
public:
- Kross::GUIClient* guiclient;
+ KoScriptingGuiClient* guiclient;
//Kross::ActionCollectionProxyModel* model;
Kross::ActionCollectionView* view;
QMap<QString, QAction* > actions;
};
-KoScriptingDocker::KoScriptingDocker(QWidget* parent, Kross::GUIClient* guiclient)
+KoScriptingDocker::KoScriptingDocker(QWidget* parent, KoScriptingGuiClient* guiclient)
: QDockWidget(i18n("Scripts"), parent)
, d(new Private())
{
@@ -154,7 +155,7 @@
delete d;
}
-Kross::GUIClient* KoScriptingDocker::guiClient() const
+KoScriptingGuiClient* KoScriptingDocker::guiClient() const
{
return d->guiclient;
}
--- trunk/koffice/libs/kokross/KoScriptingDocker.h #670291:670292
@@ -23,36 +23,91 @@
#include <QDockWidget>
#include <KoDockFactory.h>
-namespace Kross {
- class GUIClient;
-}
+class KoScriptingGuiClient;
#define KOKROSS_EXPORT KDE_EXPORT
+/**
+* The KoScriptingDockerFactory class implements a factory to
+* create \a KoScriptingDocker instances.
+*/
class KOKROSS_EXPORT KoScriptingDockerFactory : public KoDockFactory
{
public:
- KoScriptingDockerFactory(QWidget* parent, Kross::GUIClient* guiclient);
+
+ /**
+ * Constructor.
+ *
+ * \param parent The parent QWidget of the \a KoScriptingDocker .
+ * \param guiclient The \a KoScriptingGuiClient instance the
+ * docker belongs to.
+ */
+ KoScriptingDockerFactory(QWidget* parent, KoScriptingGuiClient* guiclient);
+
+ /**
+ * Destructor.
+ */
virtual ~KoScriptingDockerFactory();
- Kross::GUIClient* guiClient() const;
+
+ /**
+ * \return the \a KoScriptingGuiClient instance the docker
+ * belongs to.
+ */
+ KoScriptingGuiClient* guiClient() const;
+
+ /**
+ * \return the id the docker has.
+ */
virtual QString id() const;
+
+ /**
+ * \return the default docking area.
+ */
virtual Qt::DockWidgetArea defaultDockWidgetArea() const;
+
+ /**
+ * \return a newly created \a KoScriptingDocker instance.
+ */
virtual QDockWidget* createDockWidget();
+
private:
class Private;
Private* const d;
};
+/**
+* The KoScriptingDocker class implements a docking widget that displays
+* the scripts using the \a Kross::ActionCollectionView widget.
+*/
class KOKROSS_EXPORT KoScriptingDocker : public QDockWidget
{
Q_OBJECT
public:
- KoScriptingDocker(QWidget* parent, Kross::GUIClient* guiclient);
+
+ /**
+ * Constructor.
+ *
+ * \param parent The parent QWidget of the \a KoScriptingDocker .
+ * \param guiclient The \a KoScriptingGuiClient instance this
+ * docker belongs to.
+ */
+ KoScriptingDocker(QWidget* parent, KoScriptingGuiClient* guiclient);
+
+ /**
+ * Destructor.
+ */
virtual ~KoScriptingDocker();
- Kross::GUIClient* guiClient() const;
+
+ /**
+ * \return the \a KoScriptingGuiClient instance this docker
+ * belongs to.
+ */
+ KoScriptingGuiClient* guiClient() const;
+
private Q_SLOTS:
void slotEnabledChanged(const QString&);
void slotDoubleClicked();
+
private:
class Private;
Private* const d;
--- trunk/koffice/libs/kokross/KoScriptingGuiClient.h #670291:670292
@@ -31,16 +31,36 @@
#define KOKROSS_EXPORT KDE_EXPORT
/**
- *
- */
+* The KoScriptingGuiClient class implements the top-level guiclient
+* functionality to integrate scripting using Kross into a KOffice
+* application.
+*/
class KOKROSS_EXPORT KoScriptingGuiClient : public Kross::GUIClient
{
Q_OBJECT
public:
+
+ /**
+ * Constructor.
+ *
+ * \param guiclient The parent KXMLGUIClient instance this
+ * guiclient is child of. This will be normaly a KParts::Plugin
+ * instance that provides an application plugin using the KParts
+ * technology.
+ * \param parent The parent QObject.
+ */
explicit KoScriptingGuiClient(KXMLGUIClient* guiclient, QObject* parent = 0);
+
+ /**
+ * Destructor.
+ */
virtual ~KoScriptingGuiClient();
public Q_SLOTS:
+
+ /**
+ * Show the modal "Script Manager" dialog.
+ */
void slotShowScriptManager();
private:
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic