From 114a878c64ce6f8223cfd22d76a20eb16d177e5e Mon Sep 17 00:00:00 2001 From: toma Date: Wed, 25 Nov 2009 17:56:58 +0000 Subject: Copy the KDE 3.5 branch to branches/trinity for new KDE 3.5 features. BUG:215923 git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/kdevelop@1054174 283d02a7-25f6-0310-bc7c-ecb5cbfe19da --- lib/interfaces/external/Mainpage.dox | 57 +++++++++++++++++++++ lib/interfaces/external/Makefile.am | 15 ++++++ lib/interfaces/external/designer.cpp | 30 +++++++++++ lib/interfaces/external/designer.h | 98 ++++++++++++++++++++++++++++++++++++ 4 files changed, 200 insertions(+) create mode 100644 lib/interfaces/external/Mainpage.dox create mode 100644 lib/interfaces/external/Makefile.am create mode 100644 lib/interfaces/external/designer.cpp create mode 100644 lib/interfaces/external/designer.h (limited to 'lib/interfaces/external') diff --git a/lib/interfaces/external/Mainpage.dox b/lib/interfaces/external/Mainpage.dox new file mode 100644 index 00000000..4618c3d5 --- /dev/null +++ b/lib/interfaces/external/Mainpage.dox @@ -0,0 +1,57 @@ +/** +@mainpage The %KInterfaceDesigner Library + +This library contains all %KInterfaceDesigner classes and interfaces which form the core of +GUI Designer integration framework. + +Link with: -lkinterfacedesigner + +Include path: -I\$(kde_includes)/kinterfacedesigner + +\section designerintegration Overview of GUI designer integration process +Each KPart that wants to act as a GUI Designer must implement @ref KInterfaceDesigner::Designer +interface. It defines necessary signals to communicate with an IDE and abstract virtual +functions to determine designer type. + +If a part which can "design" user interface files of a certain mimetype +implements this interface and sets itself as a default handler for that +mimetype then it becomes automatically integrated into KDevelop IDE. + +When a part is embedded into KDevelop shell, its signals (defined in @ref +KInterfaceDesigner::Designer interface): +@code + void addedFunction(DesignerType type, const QString &formName, Function function) + void removedFunction(DesignerType type, const QString &formName, Function function) + void editedFunction(DesignerType type, const QString &formName, Function oldFunction, Function function) + void editFunction(DesignerType type, const QString &formName, const QString &functionName) + void editSource(DesignerType type, const QString &formName); +@endcode +are connected to corresponding slots of KDevelop designer integration engine which can be implemented in KDevelop language support plugin. + +Each language support which wants to use integrated designer, must reimplement +@code +virtual KDevDesignerIntegration *KDevLanguageSupport::designer(KInterfaceDesigner::DesignerType type) +@endcode +method and return designer integration object. + +Convenience designer integration support library is available for programming language support +developers. With the convenience library writing %Qt designer integration for the language is a +trivial task. + + +\section kdevdesigner KDevelop Designer technical overview +KDevelop version >= 3.1 comes with a customized version (fork ;)) of %Qt Designer. It is called KDevelop Designer (KDevDesigner, kdevdesigner from the command line). KDevDesigner has some important differences: +- KDevDesigner provides a read/write KPart which can be embedded into any application which wants to edit .ui files. KDevelop IDE embeds KDevDesigner this way. +- KDevDesigner uses %KDE icons and dialogs and thus provides better integration with a system. +. + +It is safe to preview forms with some %KDE widgets from kdeui and kio libraries - KDevDesigner part is linked to those libraries so it will not crash under some circumstances. + +KDevDesigner will not create .ui.h files - this feature is completely disabled. Integrated KDevDesigner will use subclassing approach, standalone does not allow to enter code. + +\section other Other information + +@note It is technically possible to integrate not only %Qt Designer, but also, for example, Glade. Glade-3 can be compiled as a library and probably be embedded via XParts technology. + +*/ + diff --git a/lib/interfaces/external/Makefile.am b/lib/interfaces/external/Makefile.am new file mode 100644 index 00000000..bcad37b3 --- /dev/null +++ b/lib/interfaces/external/Makefile.am @@ -0,0 +1,15 @@ +INCLUDES = $(all_includes) + +METASOURCES = AUTO + +kinterfacedesignerdir = $(includedir)/kinterfacedesigner +kinterfacedesigner_HEADERS = designer.h + +lib_LTLIBRARIES = libkinterfacedesigner.la +libkinterfacedesigner_la_LIBADD = $(LIB_QT) $(LIB_KPARTS) $(LIB_KDEUI) +libkinterfacedesigner_la_LDFLAGS = $(all_libraries) +libkinterfacedesigner_la_SOURCES = designer.cpp + +DOXYGEN_REFERENCES = dcop interfaces kdecore kdefx kdeui khtml kmdi kio kjs kparts kutils +DOXYGEN_PROJECTNAME = KInterfaceDesigner Library +include ../../../Doxyfile.am diff --git a/lib/interfaces/external/designer.cpp b/lib/interfaces/external/designer.cpp new file mode 100644 index 00000000..b7c5de7a --- /dev/null +++ b/lib/interfaces/external/designer.cpp @@ -0,0 +1,30 @@ +/* This file is part of the KDE project + Copyright (C) 2004 Alexander Dymo + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Library General Public + License as published by the Free Software Foundation; either + version 2 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Library General Public License for more details. + + You should have received a copy of the GNU Library General Public License + along with this library; see the file COPYING.LIB. If not, write to + the Free Software Foundation, Inc., 59 Temple Place - Suite 330, + Boston, MA 02111-1307, USA. +*/ +#include "designer.h" + +namespace KInterfaceDesigner{ + +Designer::Designer(QObject *parent, const char *name) + :KParts::ReadWritePart(parent, name) +{ +} + +} + +#include "designer.moc" diff --git a/lib/interfaces/external/designer.h b/lib/interfaces/external/designer.h new file mode 100644 index 00000000..5c7821fa --- /dev/null +++ b/lib/interfaces/external/designer.h @@ -0,0 +1,98 @@ +/* This file is part of the KDE project + Copyright (C) 2004 Alexander Dymo + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Library General Public + License as published by the Free Software Foundation; either + version 2 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Library General Public License for more details. + + You should have received a copy of the GNU Library General Public License + along with this library; see the file COPYING.LIB. If not, write to + the Free Software Foundation, Inc., 59 Temple Place - Suite 330, + Boston, MA 02111-1307, USA. +*/ +#ifndef KINTERFACEDESIGNER_FORMEDITOR_H +#define KINTERFACEDESIGNER_FORMEDITOR_H + +#include + +/**Contains KInterfaceDesigner classes.*/ +namespace KInterfaceDesigner{ + +/**The type of a GUI Designer.*/ +enum DesignerType { + QtDesigner /**= 3).*/ +}; + +/**Function type.*/ +enum FunctionType { + ftFunction /**