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 --- doc/Makefile.am | 2 + doc/api/Architecture.dox | 315 +++ doc/api/Architecture.png | Bin 0 -> 71707 bytes doc/api/Architecture.sxd | Bin 0 -> 7581 bytes doc/api/Development.png | Bin 0 -> 71400 bytes doc/api/Development.sxd | Bin 0 -> 8396 bytes doc/api/EditorsSupportStatus.dox | 189 ++ doc/api/FutureTasks.dox | 136 + doc/api/HighPriTasks.dox | 36 + doc/api/HowToAddApplicationTemplates.dox | 285 ++ doc/api/HowToAddFileTemplates.dox | 30 + doc/api/HowToAddGenericBuildTools.dox | 21 + doc/api/HowToAddPlugins.dox | 204 ++ doc/api/HowToAddProgrammingLanguages.dox | 252 ++ doc/api/HowToDocument.dox | 39 + doc/api/LangSupportStatus.dox | 330 +++ doc/api/Mainpage.dox | 91 + doc/api/PropEditor.dox | 108 + doc/api/propeditor1.png | Bin 0 -> 3937 bytes doc/api/propeditor2.png | Bin 0 -> 3697 bytes doc/extras/Makefile.am | 8 + doc/extras/opengl.toc | 267 ++ doc/extras/sdl.toc | 219 ++ doc/extras/w3c/Makefile.am | 3 + doc/extras/w3c/w3c-dom-level2-html.toc | 70 + doc/extras/w3c/w3c-svg.toc | 1446 ++++++++++ doc/extras/w3c/w3c-uaag10.toc | 69 + doc/kde_app_devel/Makefile.am | 3 + doc/kde_app_devel/appwizard.png | Bin 0 -> 46091 bytes doc/kde_app_devel/index.docbook | 1549 +++++++++++ doc/kde_app_devel/kscribblefiles.png | Bin 0 -> 16708 bytes doc/kdearch/Makefile.am | 2 + doc/kdearch/affine-general.png | Bin 0 -> 3182 bytes doc/kdearch/affine-rotate.png | Bin 0 -> 1941 bytes doc/kdearch/affine-scale.png | Bin 0 -> 1419 bytes doc/kdearch/affine-shear.png | Bin 0 -> 1422 bytes doc/kdearch/affine-translate.png | Bin 0 -> 1444 bytes doc/kdearch/brushstyles.png | Bin 0 -> 9874 bytes doc/kdearch/canvas.png | Bin 0 -> 24979 bytes doc/kdearch/capflat.png | Bin 0 -> 267 bytes doc/kdearch/capround.png | Bin 0 -> 441 bytes doc/kdearch/capsquare.png | Bin 0 -> 185 bytes doc/kdearch/index.docbook | 3337 ++++++++++++++++++++++++ doc/kdearch/joinbevel.png | Bin 0 -> 529 bytes doc/kdearch/joinmiter.png | Bin 0 -> 569 bytes doc/kdearch/joinround.png | Bin 0 -> 597 bytes doc/kdearch/konqi-mirrored.png | Bin 0 -> 27633 bytes doc/kdearch/konqi-normal.png | Bin 0 -> 27757 bytes doc/kdearch/konqi-rotated.png | Bin 0 -> 28953 bytes doc/kdearch/konqi-sheared.png | Bin 0 -> 25644 bytes doc/kdearch/kview-menu.png | Bin 0 -> 4204 bytes doc/kdearch/opengl.png | Bin 0 -> 4818 bytes doc/kdearch/penstyles.png | Bin 0 -> 2854 bytes doc/kdearch/whatsthis.png | Bin 0 -> 3509 bytes doc/kdevelop/Makefile.am | 3 + doc/kdevelop/SF-general.png | Bin 0 -> 13488 bytes doc/kdevelop/SF-indent.png | Bin 0 -> 19392 bytes doc/kdevelop/SF-other.png | Bin 0 -> 15840 bytes doc/kdevelop/adv-build-management.docbook | 128 + doc/kdevelop/app-changelog.docbook | 69 + doc/kdevelop/app-files.docbook | 425 +++ doc/kdevelop/app-menu.docbook | 61 + doc/kdevelop/app-misc-info.docbook | 24 + doc/kdevelop/app-uimodes-examples.docbook | 125 + doc/kdevelop/applicationwizard.docbook | 820 ++++++ doc/kdevelop/automake-file-popup.png | Bin 0 -> 24236 bytes doc/kdevelop/automake-manager.png | Bin 0 -> 18841 bytes doc/kdevelop/automake-subproject-popup.png | Bin 0 -> 13626 bytes doc/kdevelop/automake-target-popup.png | Bin 0 -> 21258 bytes doc/kdevelop/automakemanager.png | Bin 0 -> 38739 bytes doc/kdevelop/build-commands.png | Bin 0 -> 5263 bytes doc/kdevelop/build-configurations.png | Bin 0 -> 28299 bytes doc/kdevelop/build-menu-automake.png | Bin 0 -> 7307 bytes doc/kdevelop/build-menu.png | Bin 0 -> 18774 bytes doc/kdevelop/class-browsers.docbook | 90 + doc/kdevelop/classview.png | Bin 0 -> 17523 bytes doc/kdevelop/commands.docbook | 1989 ++++++++++++++ doc/kdevelop/configure-adddialog-baselibs.png | Bin 0 -> 13434 bytes doc/kdevelop/configure-adddialog-qt.png | Bin 0 -> 19096 bytes doc/kdevelop/configure-adddialog.png | Bin 0 -> 19578 bytes doc/kdevelop/configure-doctree-DevHelp.png | Bin 0 -> 58057 bytes doc/kdevelop/configure-doctree-TOC.png | Bin 0 -> 76680 bytes doc/kdevelop/configure-doctree-bookmark.png | Bin 0 -> 34257 bytes doc/kdevelop/configure-doctree-general.png | Bin 0 -> 56208 bytes doc/kdevelop/configure-doctree-textsearch.png | Bin 0 -> 42655 bytes doc/kdevelop/configure-docu-chm.png | Bin 0 -> 26368 bytes doc/kdevelop/configure-docu-custom.png | Bin 0 -> 28116 bytes doc/kdevelop/configure-docu-devhelp.png | Bin 0 -> 41947 bytes doc/kdevelop/configure-docu-dox.png | Bin 0 -> 31091 bytes doc/kdevelop/configure-docu-edit.png | Bin 0 -> 12783 bytes doc/kdevelop/configure-docu-general.png | Bin 0 -> 31183 bytes doc/kdevelop/configure-docu-indexgen.png | Bin 0 -> 14162 bytes doc/kdevelop/configure-docu-toc.png | Bin 0 -> 40144 bytes doc/kdevelop/configure-editor.png | Bin 0 -> 8479 bytes doc/kdevelop/configure-file-selector.png | Bin 0 -> 27872 bytes doc/kdevelop/configure-file-templates.png | Bin 0 -> 43131 bytes doc/kdevelop/configure-general.png | Bin 0 -> 36474 bytes doc/kdevelop/configure-project-buildconfig.png | Bin 0 -> 4785 bytes doc/kdevelop/configure-project-configure.png | Bin 0 -> 33246 bytes doc/kdevelop/configure-project-cpp.png | Bin 0 -> 17444 bytes doc/kdevelop/configure-project-cppoptions.png | Bin 0 -> 30254 bytes doc/kdevelop/configure-project-doc.png | Bin 0 -> 69953 bytes doc/kdevelop/configure-project-make.png | Bin 0 -> 24739 bytes doc/kdevelop/configure-project-run.png | Bin 0 -> 33653 bytes doc/kdevelop/configure-select.png | Bin 0 -> 34978 bytes doc/kdevelop/configure-snippets.png | Bin 0 -> 19436 bytes doc/kdevelop/create-new-project-cvs.png | Bin 0 -> 29197 bytes doc/kdevelop/create-new-project.png | Bin 0 -> 44427 bytes doc/kdevelop/createnewproject.png | Bin 0 -> 82772 bytes doc/kdevelop/createnewprojectoptions.png | Bin 0 -> 20860 bytes doc/kdevelop/credits.docbook | 24 + doc/kdevelop/cvs.docbook | 139 + doc/kdevelop/debugger.docbook | 242 ++ doc/kdevelop/doctree-add-bookmark.png | Bin 0 -> 34194 bytes doc/kdevelop/doctree-reduced.png | Bin 0 -> 24702 bytes doc/kdevelop/doctree.png | Bin 0 -> 20086 bytes doc/kdevelop/doctreeview.png | Bin 0 -> 10196 bytes doc/kdevelop/documentation.docbook | 57 + doc/kdevelop/documents-contents.png | Bin 0 -> 20872 bytes doc/kdevelop/documents-search.png | Bin 0 -> 12259 bytes doc/kdevelop/edit-doctree-TOC-entry.png | Bin 0 -> 23762 bytes doc/kdevelop/editing.docbook | 401 +++ doc/kdevelop/editor-ctags-lookup.png | Bin 0 -> 8557 bytes doc/kdevelop/editor-ctags-menu.png | Bin 0 -> 10880 bytes doc/kdevelop/editor-ctags-regenerate.png | Bin 0 -> 7758 bytes doc/kdevelop/editor-find-menu.png | Bin 0 -> 5588 bytes doc/kdevelop/editor-search-doc.png | Bin 0 -> 114190 bytes doc/kdevelop/editor-switch-header.png | Bin 0 -> 22431 bytes doc/kdevelop/empty-ide.png | Bin 0 -> 36414 bytes doc/kdevelop/file-browsers.docbook | 79 + doc/kdevelop/file-list-close-selected.png | Bin 0 -> 36603 bytes doc/kdevelop/file-list-session-create.png | Bin 0 -> 35031 bytes doc/kdevelop/file-list-session-default.png | Bin 0 -> 3879 bytes doc/kdevelop/file-selector.png | Bin 0 -> 44050 bytes doc/kdevelop/filetree.png | Bin 0 -> 10689 bytes doc/kdevelop/find-in-files.png | Bin 0 -> 24609 bytes doc/kdevelop/folded-tabs.png | Bin 0 -> 8287 bytes doc/kdevelop/getting-started.docbook | 3221 +++++++++++++++++++++++ doc/kdevelop/hello-world-app.png | Bin 0 -> 3548 bytes doc/kdevelop/importdirectory.png | Bin 0 -> 12452 bytes doc/kdevelop/index.docbook | 372 +++ doc/kdevelop/kdcop_browsing.png | Bin 0 -> 37258 bytes doc/kdevelop/kdevdesigner.png | Bin 0 -> 69839 bytes doc/kdevelop/kdevelop-ideal-mode-0.png | Bin 0 -> 107904 bytes doc/kdevelop/kdevelop-ideal-mode.png | Bin 0 -> 163776 bytes doc/kdevelop/kdevelop-install.docbook | 754 ++++++ doc/kdevelop/kdevelop-mdi-mode.png | Bin 0 -> 163219 bytes doc/kdevelop/kdevelop-scripting.docbook | 56 + doc/kdevelop/kdevelop-survey.docbook | 489 ++++ doc/kdevelop/kdevelop-tabbed-mode.png | Bin 0 -> 160823 bytes doc/kdevelop/kdevelop-toplevel-mode.png | Bin 0 -> 173323 bytes doc/kdevelop/listplugins.sh | 43 + doc/kdevelop/loading-progress-bar.png | Bin 0 -> 7813 bytes doc/kdevelop/nutshell.docbook | 242 ++ doc/kdevelop/open-project.png | Bin 0 -> 55212 bytes doc/kdevelop/open-recent-project.png | Bin 0 -> 24043 bytes doc/kdevelop/plugin-tools.docbook | 433 +++ doc/kdevelop/problem-report-all-todos.png | Bin 0 -> 11407 bytes doc/kdevelop/problem-report-marks.png | Bin 0 -> 9438 bytes doc/kdevelop/problem-report-todo.png | Bin 0 -> 28006 bytes doc/kdevelop/project-advanced.docbook | 83 + doc/kdevelop/project-management.docbook | 751 ++++++ doc/kdevelop/raw-project-warning.png | Bin 0 -> 17848 bytes doc/kdevelop/run-button.png | Bin 0 -> 4867 bytes doc/kdevelop/script_location.png | Bin 0 -> 33687 bytes doc/kdevelop/select-user-interface-0.png | Bin 0 -> 40919 bytes doc/kdevelop/select-user-interface.png | Bin 0 -> 64121 bytes doc/kdevelop/setup.docbook | 1990 ++++++++++++++ doc/kdevelop/split-source-header-navigate.png | Bin 0 -> 8696 bytes doc/kdevelop/split-source-header.png | Bin 0 -> 11044 bytes doc/kdevelop/split-windows.png | Bin 0 -> 15424 bytes doc/kdevelop/split-workspace.png | Bin 0 -> 7382 bytes doc/kdevelop/survey-manual.docbook | 228 ++ doc/kdevelop/tutorial-debug-tree.png | Bin 0 -> 15622 bytes doc/kdevelop/tutorial-hello-new.png | Bin 0 -> 221583 bytes doc/kdevelop/tutorial-hello-options.png | Bin 0 -> 6818 bytes doc/kdevelop/tutorial-new-project.png | Bin 0 -> 61543 bytes doc/kdevelop/unixdev.docbook | 386 +++ doc/kdevelop/wrong-project-location.png | Bin 0 -> 11847 bytes doc/platform/Mainpage.dox | 148 ++ doc/std/Makefile.am | 7 + doc/std/kdev3api.toc | 45 + doc/tools/Makefile.am | 4 + doc/tools/index-python | 52 + doc/tools/index-texi | 60 + doc/tools/index.xsl | 34 + doc/tools/toc-docbook | 71 + doc/tools/toc-gsdoc | 24 + doc/tools/toc-python | 57 + doc/tools/toc-texi | 47 + 190 files changed, 23284 insertions(+) create mode 100644 doc/Makefile.am create mode 100644 doc/api/Architecture.dox create mode 100644 doc/api/Architecture.png create mode 100644 doc/api/Architecture.sxd create mode 100644 doc/api/Development.png create mode 100644 doc/api/Development.sxd create mode 100644 doc/api/EditorsSupportStatus.dox create mode 100644 doc/api/FutureTasks.dox create mode 100644 doc/api/HighPriTasks.dox create mode 100644 doc/api/HowToAddApplicationTemplates.dox create mode 100644 doc/api/HowToAddFileTemplates.dox create mode 100644 doc/api/HowToAddGenericBuildTools.dox create mode 100644 doc/api/HowToAddPlugins.dox create mode 100644 doc/api/HowToAddProgrammingLanguages.dox create mode 100644 doc/api/HowToDocument.dox create mode 100644 doc/api/LangSupportStatus.dox create mode 100644 doc/api/Mainpage.dox create mode 100644 doc/api/PropEditor.dox create mode 100644 doc/api/propeditor1.png create mode 100644 doc/api/propeditor2.png create mode 100644 doc/extras/Makefile.am create mode 100644 doc/extras/opengl.toc create mode 100644 doc/extras/sdl.toc create mode 100644 doc/extras/w3c/Makefile.am create mode 100644 doc/extras/w3c/w3c-dom-level2-html.toc create mode 100644 doc/extras/w3c/w3c-svg.toc create mode 100644 doc/extras/w3c/w3c-uaag10.toc create mode 100644 doc/kde_app_devel/Makefile.am create mode 100644 doc/kde_app_devel/appwizard.png create mode 100644 doc/kde_app_devel/index.docbook create mode 100644 doc/kde_app_devel/kscribblefiles.png create mode 100644 doc/kdearch/Makefile.am create mode 100644 doc/kdearch/affine-general.png create mode 100644 doc/kdearch/affine-rotate.png create mode 100644 doc/kdearch/affine-scale.png create mode 100644 doc/kdearch/affine-shear.png create mode 100644 doc/kdearch/affine-translate.png create mode 100644 doc/kdearch/brushstyles.png create mode 100644 doc/kdearch/canvas.png create mode 100644 doc/kdearch/capflat.png create mode 100644 doc/kdearch/capround.png create mode 100644 doc/kdearch/capsquare.png create mode 100644 doc/kdearch/index.docbook create mode 100644 doc/kdearch/joinbevel.png create mode 100644 doc/kdearch/joinmiter.png create mode 100644 doc/kdearch/joinround.png create mode 100644 doc/kdearch/konqi-mirrored.png create mode 100644 doc/kdearch/konqi-normal.png create mode 100644 doc/kdearch/konqi-rotated.png create mode 100644 doc/kdearch/konqi-sheared.png create mode 100644 doc/kdearch/kview-menu.png create mode 100644 doc/kdearch/opengl.png create mode 100644 doc/kdearch/penstyles.png create mode 100644 doc/kdearch/whatsthis.png create mode 100644 doc/kdevelop/Makefile.am create mode 100644 doc/kdevelop/SF-general.png create mode 100644 doc/kdevelop/SF-indent.png create mode 100644 doc/kdevelop/SF-other.png create mode 100644 doc/kdevelop/adv-build-management.docbook create mode 100644 doc/kdevelop/app-changelog.docbook create mode 100644 doc/kdevelop/app-files.docbook create mode 100644 doc/kdevelop/app-menu.docbook create mode 100644 doc/kdevelop/app-misc-info.docbook create mode 100644 doc/kdevelop/app-uimodes-examples.docbook create mode 100644 doc/kdevelop/applicationwizard.docbook create mode 100644 doc/kdevelop/automake-file-popup.png create mode 100644 doc/kdevelop/automake-manager.png create mode 100644 doc/kdevelop/automake-subproject-popup.png create mode 100644 doc/kdevelop/automake-target-popup.png create mode 100644 doc/kdevelop/automakemanager.png create mode 100644 doc/kdevelop/build-commands.png create mode 100644 doc/kdevelop/build-configurations.png create mode 100644 doc/kdevelop/build-menu-automake.png create mode 100644 doc/kdevelop/build-menu.png create mode 100644 doc/kdevelop/class-browsers.docbook create mode 100644 doc/kdevelop/classview.png create mode 100644 doc/kdevelop/commands.docbook create mode 100644 doc/kdevelop/configure-adddialog-baselibs.png create mode 100644 doc/kdevelop/configure-adddialog-qt.png create mode 100644 doc/kdevelop/configure-adddialog.png create mode 100644 doc/kdevelop/configure-doctree-DevHelp.png create mode 100644 doc/kdevelop/configure-doctree-TOC.png create mode 100644 doc/kdevelop/configure-doctree-bookmark.png create mode 100644 doc/kdevelop/configure-doctree-general.png create mode 100644 doc/kdevelop/configure-doctree-textsearch.png create mode 100644 doc/kdevelop/configure-docu-chm.png create mode 100644 doc/kdevelop/configure-docu-custom.png create mode 100644 doc/kdevelop/configure-docu-devhelp.png create mode 100644 doc/kdevelop/configure-docu-dox.png create mode 100644 doc/kdevelop/configure-docu-edit.png create mode 100644 doc/kdevelop/configure-docu-general.png create mode 100644 doc/kdevelop/configure-docu-indexgen.png create mode 100644 doc/kdevelop/configure-docu-toc.png create mode 100644 doc/kdevelop/configure-editor.png create mode 100644 doc/kdevelop/configure-file-selector.png create mode 100644 doc/kdevelop/configure-file-templates.png create mode 100644 doc/kdevelop/configure-general.png create mode 100644 doc/kdevelop/configure-project-buildconfig.png create mode 100644 doc/kdevelop/configure-project-configure.png create mode 100644 doc/kdevelop/configure-project-cpp.png create mode 100644 doc/kdevelop/configure-project-cppoptions.png create mode 100644 doc/kdevelop/configure-project-doc.png create mode 100644 doc/kdevelop/configure-project-make.png create mode 100644 doc/kdevelop/configure-project-run.png create mode 100644 doc/kdevelop/configure-select.png create mode 100644 doc/kdevelop/configure-snippets.png create mode 100644 doc/kdevelop/create-new-project-cvs.png create mode 100644 doc/kdevelop/create-new-project.png create mode 100644 doc/kdevelop/createnewproject.png create mode 100644 doc/kdevelop/createnewprojectoptions.png create mode 100644 doc/kdevelop/credits.docbook create mode 100644 doc/kdevelop/cvs.docbook create mode 100644 doc/kdevelop/debugger.docbook create mode 100644 doc/kdevelop/doctree-add-bookmark.png create mode 100644 doc/kdevelop/doctree-reduced.png create mode 100644 doc/kdevelop/doctree.png create mode 100644 doc/kdevelop/doctreeview.png create mode 100644 doc/kdevelop/documentation.docbook create mode 100644 doc/kdevelop/documents-contents.png create mode 100644 doc/kdevelop/documents-search.png create mode 100644 doc/kdevelop/edit-doctree-TOC-entry.png create mode 100644 doc/kdevelop/editing.docbook create mode 100644 doc/kdevelop/editor-ctags-lookup.png create mode 100644 doc/kdevelop/editor-ctags-menu.png create mode 100644 doc/kdevelop/editor-ctags-regenerate.png create mode 100644 doc/kdevelop/editor-find-menu.png create mode 100644 doc/kdevelop/editor-search-doc.png create mode 100644 doc/kdevelop/editor-switch-header.png create mode 100644 doc/kdevelop/empty-ide.png create mode 100644 doc/kdevelop/file-browsers.docbook create mode 100644 doc/kdevelop/file-list-close-selected.png create mode 100644 doc/kdevelop/file-list-session-create.png create mode 100644 doc/kdevelop/file-list-session-default.png create mode 100644 doc/kdevelop/file-selector.png create mode 100644 doc/kdevelop/filetree.png create mode 100644 doc/kdevelop/find-in-files.png create mode 100644 doc/kdevelop/folded-tabs.png create mode 100644 doc/kdevelop/getting-started.docbook create mode 100644 doc/kdevelop/hello-world-app.png create mode 100644 doc/kdevelop/importdirectory.png create mode 100644 doc/kdevelop/index.docbook create mode 100644 doc/kdevelop/kdcop_browsing.png create mode 100644 doc/kdevelop/kdevdesigner.png create mode 100644 doc/kdevelop/kdevelop-ideal-mode-0.png create mode 100644 doc/kdevelop/kdevelop-ideal-mode.png create mode 100644 doc/kdevelop/kdevelop-install.docbook create mode 100644 doc/kdevelop/kdevelop-mdi-mode.png create mode 100644 doc/kdevelop/kdevelop-scripting.docbook create mode 100644 doc/kdevelop/kdevelop-survey.docbook create mode 100644 doc/kdevelop/kdevelop-tabbed-mode.png create mode 100644 doc/kdevelop/kdevelop-toplevel-mode.png create mode 100755 doc/kdevelop/listplugins.sh create mode 100644 doc/kdevelop/loading-progress-bar.png create mode 100644 doc/kdevelop/nutshell.docbook create mode 100644 doc/kdevelop/open-project.png create mode 100644 doc/kdevelop/open-recent-project.png create mode 100644 doc/kdevelop/plugin-tools.docbook create mode 100644 doc/kdevelop/problem-report-all-todos.png create mode 100644 doc/kdevelop/problem-report-marks.png create mode 100644 doc/kdevelop/problem-report-todo.png create mode 100644 doc/kdevelop/project-advanced.docbook create mode 100644 doc/kdevelop/project-management.docbook create mode 100644 doc/kdevelop/raw-project-warning.png create mode 100644 doc/kdevelop/run-button.png create mode 100644 doc/kdevelop/script_location.png create mode 100644 doc/kdevelop/select-user-interface-0.png create mode 100644 doc/kdevelop/select-user-interface.png create mode 100644 doc/kdevelop/setup.docbook create mode 100644 doc/kdevelop/split-source-header-navigate.png create mode 100644 doc/kdevelop/split-source-header.png create mode 100644 doc/kdevelop/split-windows.png create mode 100644 doc/kdevelop/split-workspace.png create mode 100644 doc/kdevelop/survey-manual.docbook create mode 100644 doc/kdevelop/tutorial-debug-tree.png create mode 100644 doc/kdevelop/tutorial-hello-new.png create mode 100644 doc/kdevelop/tutorial-hello-options.png create mode 100644 doc/kdevelop/tutorial-new-project.png create mode 100644 doc/kdevelop/unixdev.docbook create mode 100644 doc/kdevelop/wrong-project-location.png create mode 100644 doc/platform/Mainpage.dox create mode 100644 doc/std/Makefile.am create mode 100644 doc/std/kdev3api.toc create mode 100644 doc/tools/Makefile.am create mode 100644 doc/tools/index-python create mode 100755 doc/tools/index-texi create mode 100644 doc/tools/index.xsl create mode 100644 doc/tools/toc-docbook create mode 100644 doc/tools/toc-gsdoc create mode 100644 doc/tools/toc-python create mode 100755 doc/tools/toc-texi (limited to 'doc') diff --git a/doc/Makefile.am b/doc/Makefile.am new file mode 100644 index 00000000..2c7c6128 --- /dev/null +++ b/doc/Makefile.am @@ -0,0 +1,2 @@ +SUBDIRS = kdevelop std extras kde_app_devel + diff --git a/doc/api/Architecture.dox b/doc/api/Architecture.dox new file mode 100644 index 00000000..ae4ef73d --- /dev/null +++ b/doc/api/Architecture.dox @@ -0,0 +1,315 @@ +/** \file Architecture.dox + * \brief KDevelop architecture + */ + +/** \page architecture KDevelop 3 Architecture + +KDevelop uses a plugin based architecture. This will be explained in more +detail in the next sections. To add a new plugin check the \ref howToAddPlugins page. + +\section devteammodel Development Team cooperation model + +KDevelop is the result of the work of many people. To help syncronize the effords and to automate +some tasks, the team uses many tools: + + - CVS servers + - KDE Bugzilla + - Web servers + - Mailing Lists + - IRC + - Doxygen + - docbook + - LXR + - E-mail :) + - Cron Jobs + - and of course KDevelop :) + . + +They get interconnected like this: + +\image html Development.png + + +\section overview Source Overview + +\subsection source-division Main Source Divisions + +The KDevelop 3 source is divided into several parts which correspond to +subdirectories in the KDevelop project directory. There are several main +parts to distinguish, mainly: + + - src = The core part of KDevelop + - lib/interfaces = Plugin handler interface classes + - parts = The various parts using the KParts framework ( KDevPlugin children ) + - languages = \ref language-parts + - buildtools = \ref buildtool-parts + - vcs = \ref vcs-parts + - editors = \ref editor-parts + . + +\image html Architecture.png + +This image is not complete there are parts that are not displayed. See below for a more detailed description. + +\subsection core-part The Core Part of KDevelop + +\subsubsection mainwindows Main Window Objects + +There are two types of possible main window objects: + + - MainWindow implements standard MDI user interfaces: + - Top level mode (see MainWindow::switchToToplevelMode() ) + - Childframe mode (see MainWindow::switchToChildframeMode() ) + - Tab page mode (see MainWindow::switchToTabPageMode() ) + - IDEAl mode (see MainWindow::switchToIDEAlMode() ) + . + - MainWindowIDEAl implements an enhanced MDI main window providing a set of + pre-arranged access tabs around user areas. + . + +Both main window classes inherit from the KDevMainWindow class which provides +access to common window features. + +\subsubsection toplevel The TopLevel Object + +There is only one toplevel object of class KDevMainWindow in KDevelop. It can +be accessed through the static function TopLevel::getInstance() (see the +TopLevel class). + +\subsection parts-overview KDevelop Parts Overview + +All parts reside in dedicated subdirectories acording to their function. They can +be viewed according to their functionalities as follows. + +\subsubsection language-parts Programming Language Support Parts + +These parts implement a KDevLanguageSupport Class interface. +To add support for a new programming language check the \ref howToAddProgrammingLanguages page (doc/api/HowToAddProgrammingLanguages.dox file). +Take a look at \ref LangSupportStatus (doc/api/LangSupportStatus.dox file) to see the current status/features of the programming languages currently supported by KDevelop. + + - languages/ada = Support for Ada + - (see AdaSupportPart) + . + - languages/bash = Support for bash + - (see BashSupportPart) + . + - languages/cpp = Support for C/C++ + - (see CppSupportPart) + - languages/cpp/debugger = GNU Debugger frontend + - (see GDBDebugger::DebuggerPart) + . + . + . + - languages/fortran = Support for Fortran + - (see FortranSupportPart) + . + - languages/haskell = Support for Haskell + - (see HaskellSupportPart) + . + - languages/java = Support for Java + - (see JavaSupportPart) + - languages/java/degugger = Java debugger frontend + - (JAVADebugger::JavaDebuggerPart) + . + . + . + - languages/pascal = Support for Pascal + - (see PascalSupportPart) + . + - languages/perl = Support for Perl + - (see PerlSupportPart) + . + - languages/php = Support for PHP + - (see PHPSupportPart) + . + - languages/python = Support for Python + - (see PythonSupportPart) + . + - languages/ruby = Support for Ruby + - (see RubySupportPart) + . + - languages/sql = Support for SQL + - (see SQLSupportPart) + . + . + +\subsubsection buildtool-parts Build tools Parts + +These parts implement a KDevProject Class interface. + + - buildtools/ada = Ada build tool + - (see AdaProjectPart) + . + - buildtools/ant = ANT build tool + - (see AntProjectPart) + . + - buildtools/autotools = Autotools build tool + - (see AutoProjectPart) + . + - buildtools/custommakefiles = Custom makefiles build tool + - (see CustomProjectPart) + . + - buildtools/generic = Generic build tool + - (see GenericProjectPart) + . + - buildtools/pascal = Pascal build tool + - (see PascalProjectPart) + . + - buildtools/script = Script build tool + - (see ScriptProjectPart) + . + - buildtools/qmake = QMake based build tool + - (see TrollProjectPart) + . + . + + +\subsubsection vcs-parts VCS (Version Control System) Parts + +These parts implement a KDevVersionControl Class interface. + + - vcs/cervisia = Cervisia Support + - (see CervisiaPlugin) + . + - vcs/clearcase = IBM Rational ClearCase Support + - (see ClearcasePart) + . + - vcs/cvs = CVS Support + - (see CvsPart) + . + - vcs/cvsservice = cvsservice Support (Cervisia interface) + - (see CvsServicePart) + . + - vcs/perforce = Version managment system perforce integration + - (see PerforcePart) + . + - vcs/subversion = Subversion integration + - (see subversionPart) + . + . + + +\subsubsection editor-parts editor support Specific Parts + +These parts implement a KTextEditor Class interface. +Take a look at \ref EditorsSupportStatus (doc/api/EditorsSupportStatus.dox file) to see the current status/features of the editors currently supported by KDevelop. + + - editors/editor-chooser = Chooses an internal text editor + - (see EditorChooserPart) + . + - editors/nedit = KTextEditor interface for nedit + - (see KNEditFactory, Document, View) + . + - editors/qeditor = QEditor integration + - (see QEditorPart) + . + . + + +\subsubsection global-parts Global Parts + +Some of the parts are considered global - that is, they effect the entire +operation of KDevelop. + +These parts implement a KDevPlugin Class interface. + + - parts/appwizard = New Project Wizard + - see AppWizardPart + - see \ref howToAddApplicationTemplates (doc/api/HowToAddApplicationTemplates.dox file) + . + - parts/history = Project history + - (see HistoryPart) + . + - parts/konsole = Embedded Konsole + - (see KonsoleViewPart) + . + - parts/doctreeview = Documentation Viewer + - (see DocTreeViewPart) + . + - parts/openwith = "Open with" menu addon + - (see OpenWithPart) + . + - parts/fileselector = A file selection widget + - (see FileSelectorPart) + . + - parts/uimode = Customize the UI mode + - (see UIChooserPart) + . + - parts/texttools = Additional text tools + - (see TextToolsPart) + . + - parts/tipofday = A tip of the day + - (see TipOfDayPart) + . + - parts/grepview = A graphical grep utility + - (see GrepViewPart) + . + - parts/tools = Toolbar management + - (see ToolsPart) + . + - parts/regexptest = A regular expression tester + - (see RegexpTestPart) + . + - parts/abbrev = Abbreviation Expansion + - (see AbbrevPart) + . + - parts/filter = Shell Filtering and Insertion + - (see FilterPart) + . + - parts/valgrind = A graphical valgrind frontend + - (see ValgrindPart) + . + . + + +\subsubsection project-specific-parts Project Specific Parts + +These parts implement a KDevPlugin Class interface. + + - parts/astyle = Source code formatter + - (see AStylePart) + . + - parts/buglist = Bug tracking application + - (see BugList) + . + - parts/classview = Classview Manager + - (see ClassViewPart) + . + - parts/ctags = CTags frontend + - (see CTagsPart) + . + - parts/diff = Difference viewer + - (see DiffPart) + . + - parts/distpart = Aids in building and publishing the final project + - (see DistpartPart) + . + - parts/doxygen = Doxygen integration + - (see DoxygenPart) + . + - parts/filecreate = New file creation + - see FileCreatePart + - see \ref howToAddFileTemplates (doc/api/HowToAddFileTemplates.dox file) + . + - parts/fileview = File groups + - (see FileViewPart, FileGroupsPart) + . + - parts/manager = Document manager + - (see DocManager, ViewManager) + . + - parts/outputviews = Application output views + - (see AppOutputViewPart, MakeViewPart) + . + - parts/scripting = Python scripting interface + - (see ScriptingPart) + . + - parts/sourcenav = Source code navigation + - (see SourceNavPart) + . + - parts/visualboyadvance = VisualBoy Advance integration + - (see VisualBoyAdvance::VisualBoyAdvancePart) + . + . + +*/ + diff --git a/doc/api/Architecture.png b/doc/api/Architecture.png new file mode 100644 index 00000000..306881fa Binary files /dev/null and b/doc/api/Architecture.png differ diff --git a/doc/api/Architecture.sxd b/doc/api/Architecture.sxd new file mode 100644 index 00000000..b48f9a36 Binary files /dev/null and b/doc/api/Architecture.sxd differ diff --git a/doc/api/Development.png b/doc/api/Development.png new file mode 100644 index 00000000..063e63db Binary files /dev/null and b/doc/api/Development.png differ diff --git a/doc/api/Development.sxd b/doc/api/Development.sxd new file mode 100644 index 00000000..ff5b06cc Binary files /dev/null and b/doc/api/Development.sxd differ diff --git a/doc/api/EditorsSupportStatus.dox b/doc/api/EditorsSupportStatus.dox new file mode 100644 index 00000000..e826471c --- /dev/null +++ b/doc/api/EditorsSupportStatus.dox @@ -0,0 +1,189 @@ +/** \file EditorsSupportStatus.dox + * \brief Editors Support Status + */ + +/** \page EditorsSupportStatus Editors Support Status + +Kate and Kvim are part of KDE and KDevelop just uses them. + +qeditor and Nedit are interfaced via KDevelop's code. You can look at their code at editors/qeditor and editors/nedit. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
features/editorkatekvim (KDE 3.2)qeditorNedit (Disabled)
Advanced text editor
Open, close and save big text filesYNYY
Undo and redoYNY
Jump in text: next/previous character, word.YNYY
Jump to start or the end of the line/textYNYY
Go to lineYNY
Select text when jumping (character, word, line), YNY
Select all the textYNY
Copy, paste and delete selections of textYNY
PrintYNY
Advanced text view:
Horizontal and vertical scrollingYNY
Display selectionsYNY
Mouse Wheel supportYNY
Dynamic word wrapYN
Line numbersYN
Show tabsYN
Find in fileYNY
Replace in fileYNY
Coding specific properties:



Syntax highlightingYNY
Code foldingYN
SpellYN
Auto indendtNNY
+ +*/ diff --git a/doc/api/FutureTasks.dox b/doc/api/FutureTasks.dox new file mode 100644 index 00000000..fbed119a --- /dev/null +++ b/doc/api/FutureTasks.dox @@ -0,0 +1,136 @@ +/** \file FutureTasks.dox + * \brief Future tasks and ideas for the next release of KDevelop + */ +/** \page FutureTasks Future tasks and ideas for the next release of KDevelop + +\section codereftodo Code Refactoring / Improvements: + + - Core + - Make sure all lib interfaces are available via DCOP + - Find a nicer way to remove dynamic menu entries from context menus + - Resolve the path handling mess + - Project name should be able to contain spaces + - Import existing directory: Should be named "Import existing project" + and more intuitive (wizard-like) + - Question from the wizard: "I have found C++ files in your + project directory. Should C++ be the primary language of your + project?" User: [Yes/No] => Next Step... + - Something intuitive for the binary/-ies (for debugger and + execution of program), libtool ([Yes/No] for the debugger), build + tool (qmake, automake,...?), etc.., too. + - use mimetype to determine code files, not extension + (see bug # + - Make the help buttons (that we already have) open the KDevelop Handbook on + the correct page (or the index if the subject is not covered yet). + - New and improved VCS framework (Needs better description) + - Another look at the plugin system (Nees better description) + - Another look at the project files (shared, non-shared, session) + - fix(redesign?) project language switching + - editor handling could be made a bit saner if editor plugin switching was an after-restart-only feature + + - Programming Language Support Parts + - Create base classes for language support parts: + - AntlrLanguageSupport + - AntlrBackgroundParser + - AntlrProblemReporter + - Same for: + - YaccLanguageSupport + - YaccBackgroundParser + - YaccProblemReporter + - There is a possibility to create even something like + - LanguageSupportBase + + Look at java, pascal and ada support parts to get more inspiration. + There should be base classes for ada, java and pascal language supports - too much code duplication. + + - CppSupportPart + - Extended "make member" functionality - run on a .h to implement stubs for all unimplemented non-abstract methods + - Code Refactoring + - text hint type info tooltips (edit mode) + - text hint value info tooltips (debug mode) + - Make the language plugin know stuff like what file patterns to look for (for instance, "find in files" needs this) + + - Build tools Parts + - Show .po files in project management + - Custom actions for groups, targets and files for project managers: + - any menu item should be a KAction plugged into KPopupMenu, also we need to define shortcuts for any such action, + also we should make sure those actions are properly executed from a shortcut. + - AutoProjectPart + - Should be able to DND files from other targets / file list / konq to add to targets + - Should loose the experimental crashy and nonstandard "add files" dialog + - Update configure.in when sub projects are added and the project doesn't use am_edit + - Keep the correctly cased project name and save it to the project file + + - Debugger Parts + - Create a debugger support base classes. Make the current GDB support a plugin. + - Implement parts for other debuggers i.e. DBX, WDB, Ladebug, JDB, XDB, bashdb, the Perl debugger, or the Python debugger. + We can use DDD as inspiration. + - General debugger + - variable widget + - set variable by editing the value in the tree + - cast value by editing the type in the tree + - disassembly + - add breakpoint display + - set breakpoint by selecting a line as in the edit window + - allow scrolling of disassembled code about and below current limits + - add source to disassembled code as comments + - basically just re-work the whole disassemble window :) + - Bugs + - Fix "core file" handling + - Fix "attach to" handling + - Breakpoints can disappear at odd times + - When the target program crashes, the debugger can't be started again. (intermittant?) + - Break on method() - could have multiple methods which require a choice. How to handle this? + + + - Plugins + - DocTreeViewPart + - Implement plugin system for doctreeview. + - improve documentation browsing + - Check if a man page exists before offering the context menu item 'Goto manpage' + - right click -> set as bookmark in docviewer + - ClassViewPart + - Implement language-dependant plugin system for classview: + - namespaces/classes/functions are not always applicable to a language, we need a way to correctly + fill a class view and combo boxes - only a language support can do that properly. + - Distinguish vanilla c++ support from c++ + Qt extensions and show signals/slots in the class view only with Qt. (is this still valid?) + - KonsoleViewPart + - Perhaps use konsole part for the application frontend + - cd's when selecting a file, but doesn't when selecting a dir, + desired: a menu option to "cd" to that directory + - QEditor + - Replace editors/qeditor/koReplace.* and editors/qeditor/koFind.* with kdelibs/kutils/kreplace.* and kdelibs/kutils/kfind.* + + +\section extensiontodo Extensions / New Functionality: + + - Core + - implement multiple-views per document (why?) + - Document manager (not obviously useful) + - Implement Add Plugin + - Show intro page on startup + - Programming Language Support Parts + - Build tools Parts + - Plugins + - better sourcenav part (all navigation tools should be supported with at least a "back" action - forward much less important) + - Integrate kontact's TODO-List and knotes plugin. (We need something like a + server/client system that all the knotes/toto-clients are always synced.) + - a generic macro-tool (if possible, probably best implemented as a KTE plugin) + - Free grouping of files in file group plugin + + +\section misctodo Miscellaneous (and possibly invalid) items: + + - UI bugs + - Editor options dialog missing when all views are closed (virtually impossible to fix) + - If you click an error in the output view, "Next Error"/"Previous + Error" should then start from that point (already implemented?) + - Messages in status bar would look nicer if they appeared with + the same border as other items (impossible) + - Browser tool bar should truncate long menu entries so it doesn't + take so much space (already implemented?) + - Extend KDevPlugin-API in order to have a preferred border for at + least the selection parts (Automake Manager, Class Browser, File + Groups, etc...) + +*/ diff --git a/doc/api/HighPriTasks.dox b/doc/api/HighPriTasks.dox new file mode 100644 index 00000000..21116342 --- /dev/null +++ b/doc/api/HighPriTasks.dox @@ -0,0 +1,36 @@ +/** \file HighPriTasks.dox + * \brief High priority tasks + */ +/** \page HighPriTasks High priority tasks! + +\section fixMajBugs Fixing major/annoying bugs + + - Fix the mess of .kdevelop and .kdevses file. + - All project wide setings should go into .kdevelop and + - all session (and personal) options should go into .kdevses file + . + This way the .kdevelop file can be shared in teams of developers. + + +\section KDevelop2compat KDevelop 2 compatibility +(These are things that must be accomplished before we can say that KDevelop 3 +>= kdevelop 2.x UI-wise and functionality-wise!) + + - general UI issues: + - toplevel UI mode broken concerning to the accels + - [Modified] missing in mainframe caption + - captions missing for toolbar buttons + . + - build/configuration: + - cross-compiling feature missing + - make "MIN_VERSION" configurable on new project creation + . + - doctreeview: + - implement "Make User Manual" + - use kdoc to update Qt/KDE docs + . + - Solve the regression bugs. These are the ones +marked with priority "HI" in the bug database + + +*/ diff --git a/doc/api/HowToAddApplicationTemplates.dox b/doc/api/HowToAddApplicationTemplates.dox new file mode 100644 index 00000000..7eec80c7 --- /dev/null +++ b/doc/api/HowToAddApplicationTemplates.dox @@ -0,0 +1,285 @@ +/** \file HowToAddApplicationTemplates.dox + * \brief How to add application templates to the application wizard part + */ +/** \page howToAddApplicationTemplates How to add application templates to the application wizard part + +Project templates provide the developer with a basic application framework. +This is necessary for rapid application development (RAD) and makes it even possible +for an inexperienced 3rd party developer to create standard conforming +applications like kedit as well as plugins for example for kdevelop or noatun.\n\n +\ref templates_1\n + - \ref templates_1_1 + - \ref templates_1_2 + - \ref templates_1_2a + - \ref templates_1_2b + - \ref templates_1_2c + - \ref templates_1_2d + - \ref templates_1_2e + . + . +\ref templates_2\n +\ref templates_3\n +\ref templates_4\n + +
+ +\section templates_1 I. Example: How To Create a Simple KDE Application Template "KHello" + +You can find this template in $KDEDIR/share/apps/kdevappwizard/template-khello. + +\subsection templates_1_1 I.1. Step 1: Basic Skeleton + +Create a directory template-khello with the files +
+    - template-khello/app.cpp
+    - template-khello/app.h
+    - template-khello/app.desktop
+    - template-khello/app.kdevelop
+    - template-khello/appui.rc
+    - template-khello/khello
+    - template-khello/main.cpp
+    - template-khello/preview.png
+    - template-khello/script
+    - template-khello/src-Makefile.am
+    - template-khello/subdirs
+    .
+
 +\note The directory name must begin with "template-". + +\subsection templates_1_2 I.2. Step 2: The Files in Detail + +Have a look into the files! There are some variables which the application +wizard will replace: +
+    - \%{AUTHOR} ...... by the author
+    - \%{EMAIL} ....... by the e-mail address 
+    - \%{VERSION} ..... by the version
+    - \%{APPNAME} ..... by the project name (KHello)
+    - \%{APPNAMELC} ... by the project name in lowercase (khello)
+    - \%{APPNAMEUC} ... by the project name in uppercase (KHELLO)
+    - \%{LICENSE} ..... by the license (GPL, BSD, QPL, LGPL, ...)
+    - \%{LICENSEFILE} . by the licensefile
+    - \%{YEAR} ........ by the year
+    .
+
 +All this can be found in $KDEDIR/share/apps/kdevappwizard/template-common/kdevelop.pm. +\subsubsection templates_1_2a I.2.1. The Source Files + +The files template-khello/app.cpp, template-khello/app.h and +template-khello/main.cpp contain the source code that should not +be too special so that the user can implement his own ideas.\n +(There may be variables included - see \ref templates_1_2 "Step 2: The Files in Detail"). + +\subsubsection templates_1_2b I.2.2. The File template-khello/khello + +It may look like this: +\verbinclude khello/khello + +The application wizard looks into this file to get + - the information where to integrate the plugin into the the listview (Category=) + - the name (Name=) and the comment (Comment=) + - the preview image (Icon=) + - and the file templates the project uses (FileTemplates=). + . +Further information could be (not required): + - Comment= a small comment for the template. Longer comments should go into a README.devel and shown on startup + - ShowFilesAfterGeneration= a comma-separated list (without whitespaces) of files that should be opened immediately after the generation, for instance a README.devel or a source file the user has to modify, the path is relative to the project directory (example: ShowFilesAfterGeneration=src/main.cpp,src/plugin.cpp). And + - APPNAMEUC will be replaced with the projectname in uppercase, + - APPNAMELC will be replaced with the projectname in lowercase, + - APPNAME will be replaced with the projectname. + . + - DefaultDestinatonDir changes the default destination dir for the project (~) to your value, whereas HOMEDIR is a keyword + . + +\attention The file template-khello/khello must have the same name as +the right half of the directory! If the directory is template-foobar +the file must be template-foobar/foobar. + +\see AppWizardPart for more information. + +\subsubsection templates_1_2c I.2.3. Some Additional Files + +The file + - template-khello/appui.rc contains information about the toolbar and the menu. + - template-khello/preview.png will be shown in the aplication wizard. + - template-khello/app.desktop describes the application. + - template-khello/subdirs contains a list of the subdirectories (usually doc, po, src) and can be found in the project root directory. It is necessary for the autotools. + . + +\subsubsection templates_1_2d I.2.4. The File template-khello/src-Makefile.am + +This file will be copied to the $PROJECTDIR/src/. +\verbinclude khello/src-Makefile.am + +\subsubsection templates_1_2e I.2.5. The File template-khello/script + +The following script is used to install the template and replaces all +variables by the corresponding value. The result is a hopefully working +kdevelop project! +\verbinclude khello/script +
+\note There are several application templates which use some identical +files - that's why some files are taken from the "template-common"-directory. + +\section templates_2 II. Registration/Installation Of The Application Template + +The easiest way to install your template is to provide an "install.sh" shell script.\n +Example: +\code +#!/bin/sh + +kde_prefix=`kde-config --prefix` +if [ `id -u` = 0 ]; then + # we are root so install the template into the global kde directory + kde_dir=`kde-config --prefix` +else + # we are a user so install it into $HOME/.kde/share/apps/kdevappwizard directory + kde_dir=`kde-config --localprefix` + echo "Note: It would be better to install as root. Press CTRL+C to abort" +fi + +# use usual path or another one? +echo "Install dir [${kde_dir}/share/apps/kdevappwizard]:" +read newdir + +if [ "$newdir"a = a ]; then newdir="${kde_dir}/share/apps/kdevappwizard/"; fi + +# make sure the directories exist +if [ ! -e "${newdir}/template-khello" ]; then mkdir -p "${newdir}/template-khello" ; fi; +if [ ! -e "${newdir}/templates" ]; then mkdir -p "${newdir}/templates" ; fi; +if [ ! -e "${newdir}" ]; then mkdir -p "$newdir" ; fi; +if [ ! -e "${newdir}/template-common" ]; then ln -s "${kde_prefix}/share/apps/kdevappwizard/template-common" "${newdir}/template-common" ; fi; + +# install now +cp -R --target-directory "$newdir" template-khello +# the file template-khello/khello must go to the "templates" directory that +# kdevelop knows that it exists +mv "$newdir/template-khello/khello" "$newdir/templates/" +echo "done" +\endcode +\n +\attention Please test your template whether it installs and behaves correctly! Test, test and test again! ;) + +\section templates_3 III. How To Add The Template To KDevelop CVS HEAD + +This section is for kdevelop developers only. Most probably you don't have to read this!.\n +Move the directory "template-khello" to kdevelop/languages/cpp/app_templates/ +and then add the following files in kdevelop/languages/cpp/app_templates/template-khello/ +(in this example the language is c++ if you use other language replace cpp with the language name): + - ".kdev_ignore" is an empty file. It prevents KDevelop's + C++-parser from parsing the C++ template files. This is necessary because the template files are just code templates and not real code (yet). + - ".cvsignore" looks like this: +\code +Makefile +Makefile.in +script.local +\endcode + - "Makefile.am" looks like this: + \verbinclude khello/Makefile.am + . +Finally add "template-khello" to "SUBDIRS = " in kdevelop/languages/cpp/app_templates/Makefile.am.\n +\attention Please test your template whether it installs and behaves correctly! +Test, test and test again! It works? Well - now talk to the kdevelop guys so +that they know what's going on and probably you may commit. ;) + +\section templates_4 IV. Changes to the template system (VERY IMPORTANT) + +The entire app template system described above has been changed. +To port a template to the new system the +information from the script file will need to be moved into the ini file. +The example is as follows: +\code +install( +"${src}/template-chello/app.kdevelop","${dest}/${APPNAMELC}.kdevelop" ); +\endcode +becomes +\code +[PROJECT] +Type=install +Source=%{src}/template-chello/app.kdevelop +Dest=%{dest}/%{APPNAMELC}.kdevelop +\endcode + +Things like installIncAdmin(); and installGNU(); now involve unpacking +the tar archives. This is done by creating a target in the ini file as +follows: +\code +[GNU] +Type=install archive +Source=%{src}/template-common/gnu.tar.gz +Dest=%{dest} +\endcode + +The popular script functions convert as follows: +\code +installIncAdmin(); %{src}/template-common/incadmin.tar.gz +installGNU(); %{src}/template-common/gnu.tar.gz +installAdmin(); %{src}/template-common/admin.tar.gz +installGnome(); %{src}/template-common/gnome.tar.gz +installWX(); %{src}/template-common/wxwidgets.tar.gz +\endcode + + +To create directories is now: +\code +[SRC] +Type= mkdir +Dir=%{dest}/src +\endcode + +New additions are as follows: +\code +[MGS] +Type=message +Comment=A simple C project was created in %{dest}. +\endcode + +Will allow you to display a custom message when the template has +finished installing. This is very handy for projects that require +custom variables to be set. + +The concept of custom variables was also introduced. To create a +variable that can be edited from the project wizard you need to add an +entry as follows: +\code +[LIBS] +Type = value +ValueType= +Value= +Comment= +Default= +\endcode + +One special value can be used to turn targets on and off. This is done +by adding a value as follows: +\code +[DOCSOPT] +Type = value +ValueType=bool +Value=INSTALL_DOCS +Comment= Install Docbook documentation templates. +Default=true +\endcode + +Then in the targets you wish to make optional you add the Option +property with the value's name as the data. This will look as follows: +\code +[DOCSDIREN] +Type=mkdir +Dir=%{dest}/doc/en +Option=INSTALL_DOCS +\endcode + +The Option target is available to the mkdir, install, and install +archive targets. + +The last new addition is the optional post processing of the files as +they are copied. For install and install archive you can add a +Process=true or Process=false to turn the processing on or off. + +A note on the UI. its not final, it will get better. Suggestions or +bugs should be noted asap. + +*/ diff --git a/doc/api/HowToAddFileTemplates.dox b/doc/api/HowToAddFileTemplates.dox new file mode 100644 index 00000000..fa6e630b --- /dev/null +++ b/doc/api/HowToAddFileTemplates.dox @@ -0,0 +1,30 @@ +/** \file HowToAddFileTemplates.dox + * \brief How to add file templates to the file create part + */ +/** \page howToAddFileTemplates How to add file templates to the file create part + +File templates provide the developer with a basic file. They are prototypes for both source files of +the project's language, and for other files that may be useful in the project. For example, a C++ +project may have templates for both .cpp and .h files, plus QT Designer .ui files, and supporting +files such as XML. + +These prototypes are placed in parts/filecreate/file-templates dir or +languages/YOURLANGUAGE/file_templates and have names equal to the extensions of language +source files. + +Sometimes, different 'flavours' of template are required for a particular file type. In these +instances, 'subtypes' can be defined to allow several different templates for a file type. An example +of this are QT designer '.ui' files. KDevelop supplies several different templates for .ui +files. Subtypes are named by the file type extension followed by a hyphen followed by an identifier +for the subtype. E.g. ui-widget, ui-dialog + +The description of the prototypes is placed in parts/filecreate/template-info.xml. This +file is fairly self-explanatory if you take a look at it. + +Note that templates and templates information can be edited within KDevelop itself. The global +templates that can be made available to any project can be changed in Settings / Configure KDevelop... / New File +Wizard; and project related settings can be changed in Project / Project Options / New File Wizard. + +That's all! :) + +*/ diff --git a/doc/api/HowToAddGenericBuildTools.dox b/doc/api/HowToAddGenericBuildTools.dox new file mode 100644 index 00000000..b073cf0f --- /dev/null +++ b/doc/api/HowToAddGenericBuildTools.dox @@ -0,0 +1,21 @@ +/** \file HowToAddGenericBuildTools.dox + * \brief How to add a generic build tool plugins to the generic build tool part + */ + +/** \page howToAddGenericBuildTools How to add a generic build tool plugins to the generic build tool part + +This part offers build tool facilities using project files in xml format (dtd is located in buildtools/generic/kdevxmlproject.dtd). +Those xml files can be converted into makefiles, ant xml files or simply shell scripts using build system plugins. +Build system plugin is an object that implements KDevBuildSystem interface. +Build system plugins are located in buildtools/generic/buildsystem. + +\section sectionStep1 Step 1: Make your plugin loadable + +For a plugin foo, create a file foo.desktop which contains KDevelop/Part in its list of ServiceTypes. + +The rest of this document is to be written. + +Document your plugin in the way described at \ref howToDocument (doc/api/HowToDocument.dox file). + +*/ + diff --git a/doc/api/HowToAddPlugins.dox b/doc/api/HowToAddPlugins.dox new file mode 100644 index 00000000..ce8f259a --- /dev/null +++ b/doc/api/HowToAddPlugins.dox @@ -0,0 +1,204 @@ +/** \file HowToAddPlugins.dox + * \brief How to extend KDevelop via plugins + */ + +/** \page howToAddPlugins How to extend KDevelop via plugins + +\section createDesktop Step 1: Make your plugin loadable + +For a plugin foo, create a file foo.desktop which contains KDevelop/Part in its list of ServiceTypes. + + - See parts/doctreeview/kdevdoctreeview.desktop for an example. + . + +If you install this file into \$(kde_servicesdir), your plugin will automatically be loaded. + +\subsection changeLoading How to change the default loading + +You can change the default loading by changing some settings in your foo.desktop file: + + - Set X-KDevelop-Scope= to Global or + Project + - Note: This property is not optional + . + - You can add a list of programming languages which are supported by your + plugin + - If your plugin works with all languages leave the + X-KDevelop-ProgrammingLanguages= field empty + (optional) + . + - You can add a list of keywords. + - The plugin will only be loaded if all keywords match with the + Keywords= field in the projectfile (optional). + . + . + +An example from the Java Debugger Plugin: + +
+    #######################
+    X-KDevelop-Scope=Project
+    X-KDevelop-ProgrammingLanguages=Java
+    Keywords=
+    ##########################
+
 + + +\section createFactory Step 2: Make the plugin accessible by the factory + +Create a factory class FooFactory which inherits +KDevFactory. Put a section + +
+    extern "C" {
+        void *init_libfoo()
+        {
+            return new FooFactory;
+        }
+    }
+
 + +into the source file, so that the factory can be accessed by KDE's library +loader. Keep in mind that the name of the method init_libfoo() is +required for a library with the name libfoo.so. + +This may be simplified by the use of the +K_EXPORT_COMPONENT_FACTORY macro which is defined in +klibloader.h: + + +K_EXPORT_COMPONENT_FACTORY( libfoo, FooFactory ); + + + - Note: Your factory must reimplement the + createPartObject() method of KDevFactory and + produce the part there. + . + +See parts/doctreeview/doctreeviewfactory.cpp for an example. + + +\section implementPart Step 3: Implement your part. + +Your part must be derived from KDevPlugin. + + - KDevPlugin takes two arguments: + - 1) A parent argument. This also comes from + createPartObject(). + - 2) A name, which in turn is given to the QObject + constructor. + . + . + +\subsection accessIDE How to access other IDE components + +A part can access other components of the IDE via some accessors +of KDevPlugin: + + - The application core via core(), + - the build tools via project(), + - the programming language specific stuff via + languageSupport(), + - the make frontend via makeFrontend(), + - the part which displays appication output via + appFrontend(), + and finally + - the symbol database via classStore(). + . + +In order to see what these components provide, see lib/interfaces/kdev*.h. + +\subsection userPrefs How to store user preferences + +Parts can also store user preferences on a per-project basis. To this +end, they can access a QDomDocument representing the project file +(which is stored as xml) via document(). + +Take attention to the issue that the project file usually is shared in a team of +developers (e.g. via version control application CVS). So some user preferences might be +very individual, and some may be valid for all of the team - project-wide so to speak. + +That's why the KDevelop architecture makes a difference here and supports two files +which will be stored in the project root directory. They are the project file (*.kdevelop) +and the session (*.kdevses) file. The later is for individual settings, not to be thought +to be shared. + +\subsection domProject Project file (*.kdevelop) + +For your convenience, you don't have to use the quite complex DOM API. Strings +can very easily be read from and written to this document using the +DomUtil class. Here, entries are identified by a 'path' in the +document. You can think of the DOM document as representing a file system +rooted in the dom document node. + +For example, the autoproject part uses the statement + +
+    QString cflags = DomUtil::readEntry( *part->document(),
+                                         "/kdevautoproject/cflags" );
+
 + +to read the CFLAGS variable set by the user, and uses the statement similar to + +
+    DomUtil::writeEntry( *part->document(),
+                         "kdevautoproject/cflags",
+                         "--no-exceptions" );
+
 + +to write it back. + + - Note: In order to avoid conflicts between different plugins, you + should use your part name as top-level 'directory' in the configuration + tree. + . + +\subsection sessionAccess Project session file (*.kdevses) + +The base class of all KDevelop plugins is KDevPlugin. It provides two virtual methods +restorePartialProjectSession(..) and savePartialProjectSession(..) +that you should reimplement in your special plugin to attach to session loading and saving. + +When KDevelop loads or closes a project, the program's project session manager +(class ProjectSession) calls them for each plugin. That manager gives a QDOM node to the +plugin where it can read out or build up its partial DOM subtree with the session settings. +That subtree will be stored in the .kdevses file by that session manager. + +For example each programmer has set breakpoints in different files than the other ones of +the team. So the debugger plugin saves them to project session file: + +
+void DebuggerPart::savePartialProjectSession(QDomElement* el)
+{
+    gdbBreakpointWidget->savePartialProjectSession(el);
+}
+void GDBBreakpointWidget::savePartialProjectSession(QDomElement* el)
+{
+    QDomDocument domDoc = el->ownerDocument();
+    if (domDoc.isNull()) return;
+    QDomElement breakpointListEl = domDoc.createElement("breakpointList");
+    for ( int row = 0; row < m_table->numRows(); row++ )
+    {
+        BreakpointTableRow* btr = (BreakpointTableRow *) m_table->item(row, Control);
+        Breakpoint* bp = btr->breakpoint();
+        QDomElement breakpointEl = domDoc.createElement("breakpoint"+QString::number(row));
+        breakpointEl.setAttribute("type", bp->type());
+        breakpointEl.setAttribute("location", bp->location(false));
+        breakpointEl.setAttribute("enabled", bp->isEnabled());
+        breakpointEl.setAttribute("condition", bp->conditional());
+        breakpointListEl.appendChild(breakpointEl);
+    }
+    if (!breakpointListEl.isNull()) el->appendChild(breakpointListEl);
+}
+
+}
+
 + +Note that the .kdevses is related to a project. User settings equal for all projects don't +belong to here. You save them to ~/.kde/share/config/kdeveloprc via class KConfig of the +kdecore library. + +Document your part in the way described at \ref howToDocument (doc/api/HowToDocument.dox file). + +*/ + diff --git a/doc/api/HowToAddProgrammingLanguages.dox b/doc/api/HowToAddProgrammingLanguages.dox new file mode 100644 index 00000000..5cfa3643 --- /dev/null +++ b/doc/api/HowToAddProgrammingLanguages.dox @@ -0,0 +1,252 @@ +/** \file HowToAddProgrammingLanguages.dox + * \brief How to add support for a programming language + */ + +/** \page howToAddProgrammingLanguages How to add support for a programming language + +\section LSupport List of things to have "complete" support of a given language in KDevelop + + - Implement interface KDevLanguageSupport + - \ref sectionClassWizard + - \ref sectionAttributeMethodWizard + - \ref sectionQtUiSubclassing - (if the language has Qt bindings) + - \ref sectionLanguageParser + - \ref sectionClassStore + - \ref sectionMemoryClassStore + - \ref sectionPersistantClassStore + . + - \ref sectionCodeCompletion + - \ref sectionProblemReporter - (parses source on the fly and reports syntax errors) + - \ref sectionTemplates + - \ref sectionApplicationTemplates + - \ref sectionApplicationImportTemplates + - \ref sectionSourceFileTemplates + - \ref sectionAbbreviationTemplates - (ife expands to an if else statement, etc) + . + - \ref sectionSourceCodeFormater (prettyprint functionality) + - \ref sectionDocumentationTopics + - \ref sectionDebugger + - (gdb/jdb/??? integration) + - \ref sectionCompilerPlugins + . + +List of optional things to support a given language in KDevelop: + - \ref sectionEditor - Syntax highlighter - (add to QEditor if not available elsewhere) + - \ref sectionBuildTool (make/ant/etc) + . + +Take a look at \ref LangSupportStatus (doc/api/LangSupportStatus.dox file) to see the current status/features of the programming languages currently supported by KDevelop. + + + + +\section sectionLanguageSupport Language Support + +Any language support should be written as a kdevelop part and implement +KDevLanguageSupport interface (lib/interfaces/kdevlanguagesupport.h). + +Implementing methods: + - virtual Features features(); + - virtual KMimeType::List mimeTypes(); + . + +Should be enough for a language support to start working. + +KDevelop ships with KDevLang project template. It is a simple language support prototype that can be used when developing language support plugins with KDevelop. +To use it, start a New Project and select: C++->KDevelop->KDevelop Language Support Plugin in the application wizard. +The template is located in languages/cpp/app_templates/kdevlang, you can change it there if you need. + + +You should look at languages/ruby for a simple language support +implementation. For a compilable language support, consult languages/ada or languages/pascal (they are not so complex as languages/cpp). + +Pascal would be a good starting place, as it is the smaller of the two by far. + +Language support can offer additional features: + +\subsection sectionClassWizard Class wizard + - new class wizard: (See ada, php, cpp or java) + - virtual void addClass(); + . + +\subsection sectionAttributeMethodWizard Attribute/Method wizard + - add method dialog: (See cpp or java) + - virtual void addMethod(const QString &className); + . + - add attribute dialog: (See cpp or java) + - virtual void addAttribute(const QString &className); + . + . + +\subsection sectionQtUiSubclassing Qt UI subclassing + +If there is a Qt bindings for your language and there is a possibility +to use QtDesigner ui files, you could implement ui subclassing feature: + - virtual QStringList subclassWidget(const QString& formName); + - virtual QStringList updateWidget(const QString& formName, const QString& + fileName); + . + +See cpp and java for examples. + +\subsection sectionLanguageParser Language parser + +In general, class stores can be filled with information without specialized +and complex language parsers (take a look at languages/python that have a very simple python parser) but your language support will surely benefit +from having such. There is a hand-written c/c++ parser (lib/cppparser) in KDevelop that might be used for ObjC or related C-based languages. + +Other (not so complex as c++) languages can be parsed by ANTLR based parsers (library is in lib/antlr). +Consult www.antlr.org for a ANTLR documentation and look at languages/java, languages/ada and languages/pascal for an example of using such parsers. +The latest version of ANTLR (2.7.2) has support for Java, C, Pascal, Ada, C++, CIM, HTML, IDL, Verilog, VRML, OCL, ASN.1, and SQL. You can write an ANTLR parser for your own language, of course. + +\subsection sectionClassStore Class store + +If you write (or have) a language parser, your language support can have +"class store" (a database containing the information about scopes, classes +and methods - their names, names of source files, location in source files, +etc.). Class store libraries can be found at lib/catalog (Catalog) and lib/interfaces (CodeModel). + +KDevelop provides class browsers that extract information from a class store and display it in a tree view and toolbar selectors of scopes, classes and methods. + +\subsubsection sectionMemoryClassStore Memory class store +CodeModel is the memory class store. It is very efficient and thus it is recommended for using as a project class store. CodeModel libraries are located in lib/interfaces/codemodel.h. The class browser for a CodeModel based stores is parts/classview. + +\subsubsection sectionPersistantClassStore Persistant class store +Catalog is the persistant class store for KDevelop. Persistant class store can be used as an information storage for code completion but it also can be used as a class store for the project. Take a look at +languages/cpp for an example of using catalog. Catalog is stored on disk in the database file (Berkeley db) If you use catalog with the project, your class browser will be parts/classbrowser. + +\subsection sectionCodeCompletion Code completion +Class store enables you to write a code completion for the language. At the +moment (2003-06-25), code completion is available only to cpp so take a +look at it for an example. + +\subsection sectionProblemReporter Problem reporter + +If you have a language parser, you can implement problem reporter +functionality for your language. The problem reporter catches errors +reported by a parser and displays it in a problem reporter view. +languages/java, languages/ada, languages/pascal and languages/cpp have problem reporters. + +\subsection sectionTemplates Templates + +\subsubsection sectionApplicationTemplates Application templates + +Application wizard templates should be also written. Appwizard templates are simple to create - consult \ref howToAddApplicationTemplates (HowToAddApplicationTemplates.dox file) +and look at languages/ruby/app_templates/rubyhello, languages/pascal/app_templates/pascalhello, or languages/ada/app_templates/adahello. + +\subsubsection sectionApplicationImportTemplates Application import templates + +KDevelop has the ability to create a new project from existing projects or source code. +It scans for project files ('*.kdevelop, *.kdevprj, *.studio, *.pro) and if + - it finds a project it extracts the necessary information + - it does not find project files it scans for source files (*.cpp, *.java, *.pl, *.py, ...) + . +and creates a new KDevelop project in the direcotry the user has chosen. + +\subsubsection sectionSourceFileTemplates Source file templates + +Another thing to do is to create file create templates. They are prototypes for a source files of your language. These prototypes are placed in +parts/filecreate/file-templates dir or languages/YOURLANGUAGE/file_templates and have names equal to the extensions of language source files. +The description of the prototypes is placed in parts/filecreate/template-info.xml. + +Consult FileCreatePart (parts/filecreate/README.dox file) and \ref howToAddFileTemplates for further information. + +\subsubsection sectionAbbreviationTemplates Code abbreviation templates + +KDevelop has a support for code abbreviations so you can add some predefined abbreviations to your language support. Take languages/cpp/cpptemplates as an example. + + +\subsection sectionSourceCodeFormater Source code formater + +Implement a KDevSourceFormater class interface. +To obtain source formater functionality (that is already available to +c-based languages) you can extend astyle library (lib/astyle) that is used by KDevelop to format sources. +Take a look at AStylePart for an example how to do it. + +\subsection sectionDocumentationTopics Documentation topics + +Add them to languages/YOURLANGUAGE/doc. For an example see languages/python/doc/python.toc and languages/python/doc/python.index +In the end you need to edit the languages/YOURLANGUAGE/doc/Makefile.am file to include the .toc and/or .index file. + +\subsection sectionDebugger Debugger + +The last thing to have a complete language support in KDevelop is to +write a Debugger . KDevelop already provides GDB support +(languages/cpp/debugger) and JDB (java debugger) support (languages/java/debugger). Take a look at them to get inspiration. + +\subsection sectionCompilerPlugins Compiler plugins + +There is an ability to create compiler plugin for KDevelop. Compiler plugin provides the compiler configuration dialog which implements command line compiler options. +Compiler plugins must implement KDevCompilerOptions interface. + + +\section MiscInf Other Info + +In the end you should add the language you implemented to the doc/api/LangSupportStatus.dox file and +document your language support part in the way described at \ref howToDocument (doc/api/HowToDocument.dox file). +See also \ref howToAddPlugins (doc/api/HowToAddPlugins.dox file) for an information on how to create a generic KDevelop plugin and how to manage project and global configuration information. + + + + + +\section sectionEditor Language Editor + +To edit source files KDevelop uses any editor that supports the KTextEditor +interface. The current supported editors and their features are listed +in the \ref EditorsSupportStatus (doc/api/EditorsSupportStatus.dox file) page. + +In case none of the editors does support advanced editing of sources +written in your language (like code folding, syntax highlighting, line +indentation) you can improve QEditor included in KDevelop (editors/qeditor). +By creating QEditorIndenter and QSourceColorizer descendants you can provide the support for an automatic indentation and syntax highlighting that will be available for sure in KDevelop. + + + + + + +\section sectionBuildTool Build Tool + +The language support is important, but it is unusable without a build tool +that can manage projects written on this language. KDevelop +currently provides several build tools. They are: + + - ANT build tool + - see AntProjectPart at buildtools/ant + . + - Autotools build tool + - see AutoProjectPart at buildtools/autotools + . + - Custom build tool + - see CustomProjectPart at buildtools/custommakefiles + - (works with custom makefiles, also has ant support) + . + - Generic build tool + - see GenericProjectPart at buildtools/generic + - Offers build tool facilities using project files in xml format (dtd is located in buildtools/generic/kdevxmlproject.dtd). + Those xml files can be converted into makefiles, ant xml files or simply shell scripts using build system plugins. + Build system plugin is an object that implements KDevBuildSystem interface. Build system plugins are located in buildtools/generic/buildsystem. + . + - QMake build tool + - see TrollProjectPart at buildtools/qmake + . + . + +Also available: + - Script build tool + - buildtools/script + - (the generic build tool for all scripting languages). + . + - buildtools/pascal and + - buildtools/ada + - buildtools/haskell + . + +(They are deprecated build tools that will be replaced with the generic build tool). + +Choose your build tool and if the existing build tools doesn't fit +in, extend generic build tool via build system plugin. \ref howToAddGenericBuildTools page (doc/api/HowToAddGenericBuildTools.dox file) helps you to do it. + + +*/ diff --git a/doc/api/HowToDocument.dox b/doc/api/HowToDocument.dox new file mode 100644 index 00000000..d606a8bf --- /dev/null +++ b/doc/api/HowToDocument.dox @@ -0,0 +1,39 @@ +/** \file HowToDocument.dox + * \brief How to document KDevelop parts + */ +/** \page howToDocument How to document KDevelop parts + +You should add a README and a README.dox file to your part (KDevPlugin). + +On the README file put this text: +\verbatim +Please read the on-line, automaticaly updated KDevelop API documentation at: +http://www.kdevelop.org +or read the README.dox file. +\endverbatim + +On the README.dox file put the mandatory information: +\verbatim +/** \class yourPartClassName +Put a brief description here, the brief description ends at the first dot. +Put a more detailed description of your part in these lines. It can span +over several lines. You can even use some html commands in these lines like: +This is code, html links link text, +and images. + +... + +/* +\endverbatim + +IMPORTANT: You should replace yourPartClassName with the name of the class that +implements your part. + +On the area marked with ... you can add optional informations. Here is an example of that: + +\verbinclude languages/cpp/app_templates/kdevpart/README.dox + +All these infos are optional and you should only add the link to the bugzilla database if YOUR_COMPONENT_NAME +has been defined in that database. + +*/ diff --git a/doc/api/LangSupportStatus.dox b/doc/api/LangSupportStatus.dox new file mode 100644 index 00000000..fa08cc67 --- /dev/null +++ b/doc/api/LangSupportStatus.dox @@ -0,0 +1,330 @@ +/** \file LangSupportStatus.dox + * \brief Programming Languages Support Status + */ + +/** \page LangSupportStatus Programming Languages Support Status + +\ref howToAddProgrammingLanguages (doc/api/HowToAddProgrammingLanguages.dox file) for step by step info on how to implement these features. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Feature/LanguageAdaBashC/C++FortranHaskellJavaPascalPerlPHPPythonRubySQL
\ref sectionClassWizardYN/AYN/AN/AYNNYNNN/A
\ref sectionAttributeMethodWizardNN/AYN/AN/AYNNNNNN/A
\ref sectionQtUiSubclassingN/AN/AYN/AN/AYN/AN/AN/ANN/AN/A
\ref sectionLanguageParserANTLRInternalcppparserInternalNANTLRANTLRInternalInternalInternalNN
\ref sectionMemoryClassStoreCodeModelCodeModelCodeModelCodeModelNCodeModelCodeModelCodeModelCodeModelCodeModelNY
\ref sectionPersistantClassStoreNNCatalogNNNNNNNNN/A
\ref sectionCodeCompletionNYYNNNNNYNNN
\ref sectionProblemReporterYNYNNYYNYNNN
\ref sectionApplicationTemplatesYYYYYYYYYYYY
\ref sectionApplicationImportTemplatesYNYYNYYYYYYN
\ref sectionSourceFileTemplatesYNYYYYYYYYYN
\ref sectionAbbreviationTemplatesNNYNN/ANYNYNNN
\ref sectionSourceCodeFormaterNNYNNYNNNNNN
\ref sectionDocumentationTopicsYYYNYYNYYYYN
\ref sectionDebuggerNNYNN/AYNNNNNN
\ref sectionCompilerPluginsNN/AgccPGHPF, PGF77GlasgowNDelphi, Free PascalNNNNN
+
+Legend: +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Feature has not been implemented
Feature is in alpha state, the development has only been started or the feature is turned off at the moment
Feature is in beta state or it is unfinished
Feature is considered to be complete or complete enough for the release
N/AFeature is not applicable for given language
SourceinfoDeprecated class store that should be replaced by a CodeModel +
Features implemented with Sourceinfo should not be marked as complete
CodeModelNew memory class store
CatalogNew persistant class store using Berkeley DB storage backend
ANTLRLanguage parser is generated by ANTLR parser generator, http://www.antlr.org
cppparserNew c/c++ parser written by Roberto Raggi for KDevelop
InternalLanguage parser is included in language support part
+ +*/ + diff --git a/doc/api/Mainpage.dox b/doc/api/Mainpage.dox new file mode 100644 index 00000000..9d4b6d4c --- /dev/null +++ b/doc/api/Mainpage.dox @@ -0,0 +1,91 @@ +/** \file Mainpage.dox + \brief The main page of the doxygen generated %API Documentation +*/ + +/** +\mainpage The KDevelop %API %Documentation + +KDevelop is an easy to use IDE (Integrated Development Environment) for developing applications under X11. + +\section intro Introduction + +This document is targeted at all those that want to add or improve KDevelop's source code. +If you are instead looking for a user manual, just go to the help menu of your KDevelop and select KDevelop handbook. +This documentation contains the KDevelop online class reference for the current +development version of KDevelop. Additionally, you +can subscribe or read the mailing list for any additions and/or +modifications to the %API. + +An on-line, updated every 24H, html version of this documentation can be found at: http://www.kdevelop.org/HEAD/doc/api/html/index.html + +More information about the KDevelop architecture in form of tutorials, HOWTOs, +and FAQs can be found at +the KDevelop website. + + +\section status Current Status + +Here you can see the current \ref requirements and the \ref features. +There is also a \ref LangSupportStatus (doc/api/LangSupportStatus.dox file) page and a \ref EditorsSupportStatus (doc/api/EditorsSupportStatus.dox file) page. + + +\section expand How to expand KDevelop + +First of all read the \ref architecture (doc/api/Architecture.dox file) then you can find more information on how to expand KDevelop: + - \ref howToAddPlugins (doc/api/HowToAddPlugins.dox file) + - \ref howToAddProgrammingLanguages (doc/api/HowToAddProgrammingLanguages.dox file) + - \ref howToAddApplicationTemplates (doc/api/HowToAddApplicationTemplates.dox file) + - \ref howToAddFileTemplates (doc/api/HowToAddFileTemplates.dox file) + - \ref howToAddGenericBuildTools (doc/api/HowToAddGenericBuildTools.dox file) + +Additionally you may also want to find out \ref howToDocument (doc/api/HowToDocument.dox file). + +\section PlannedTasks Planned tasks + +Here is a priority ordered list: + -# \ref HighPriTasks (doc/api/HighPriTasks.dox file) + -# fix the dispersed \ref fixme + -# reported bugs in bugzilla database + -# fix the bugs in the \ref bug + -# fix the dispersed \ref todo all over the code. + . +There are some \ref unmaintained parts in KDevelop. You migth want to "adopt" one. :)\n +There is also \ref FutureTasks (doc/api/FutureTasks.dox file). Put all ideas for the future KDevelop releases there. It is also a good place to comment on those ideas. + +\section misc Misc + + - \ref authors + - \ref maintainers + - \ref FAQ + - \ref deprecated + +\section misc_libs Miscellaneous libraries included in KDevelop + - \ref PropEditor + +\section howTobuildAPIlocalcopy How to build a local copy of this documentation + +This documentation is very large and changes with every cvs commit, therefore is not available for download. +To build your local copy of this documentation you have two choices, depending on your system configuration. + - If you have doxygen >= 1.3.4 , PHP >= 4.10 and a local running webserver then + - make apidox + - make install-apidox (as root) + . + - If you have an older system then + - setenv KDEDIR=/location_of_your_kde_instalation + - setenv QTDIR=/location_of_your_qt_instalation + - doxygen Doxyfile + - make install-apidox (as root) + . + . + +The advantage of the first method is that you'll get a search engine in your documentation if you read your +documentation using your local webserver. + +\section License + +Permission is granted to copy, distribute and/or modify this document under +the terms of the GNU Free %Documentation License, Version 1.2 or any later +version published by the Free Software Foundation; For details see +http://www.gnu.org/copyleft/fdl.html . + +*/ diff --git a/doc/api/PropEditor.dox b/doc/api/PropEditor.dox new file mode 100644 index 00000000..b4f4eccc --- /dev/null +++ b/doc/api/PropEditor.dox @@ -0,0 +1,108 @@ +/** \file PropEditor.dox + \brief The KDevelop Property Editor library description page +*/ + +/** \page PropEditor KDevelop Property Editor library description + +\section whatis What is Property Editor? + +%Property editor is a collection of facilities to store and edit the +properties of an object. For example, look at %Qt Designer. Each widget +has a list of properties that can be edited in a nice table form. +Same ideology is used to edit properties in Kugar Report Designer +(from KOffice distribution). In KDevelop project manager can also display +the properties of currently selected build item in property editor. + +\section over Library Overview + +This PropertyEditor library is a redesign of Kugar property editing library +with the goal to be more generic and extensible. + +Library provides a @ref PropertyLib::Property class which stores property name, value and some +more important information like description or the list of possible values. +Using @ref PropertyLib::Property class adds more overhead over Q_PROPERTY but provides more +flexibility. You can subclass @ref PropertyLib::Property and create your custom properties. +Custom properties can have either predefined type (see @ref PropertyLib::PropertyType) or +custom type. Custom type should be used if a custom property editor widget is +necessary. + +Properties are organized into lists. @ref PropertyLib::PropertyList is designed +to store such lists in most efficient manner. It also allows to group +properties (for example think about "geometrical" properties like "x", "y", etc.). + +Property lists can be displayed in @ref PropertyLib::PropertyEditor widget which will +display them in a table form. Note that @ref PropertyLib::PropertyEditor takes not +a @ref PropertyLib::PropertyList object, but @ref PropertyLib::PropertyAccessor instead. + +@ref PropertyLib::PropertyAccessor is designed to provide a method to access an intersection +of property lists. For example, let's consider object A with property list a_list +abd object B with list b_list. Now let's imagine we want to display common properties +from a_list and b_list in one @ref PropertyLib::PropertyEditor widget. Obviously, we need to +"intersect" a_list with b_list and display the result of intersection. +This is why @ref PropertyLib::PropertyAccessor is used for editing. If we change +the value of a property in the editor, @ref PropertyLib::PropertyAccessor will update +both properties from underlying a_list and b_list. + +@ref PropertyLib::PropertyEditor at the same time shows only one editor for selected +property in the list. Each @ref PropertyLib::PropertyType has corresponding @ref PropertyLib::PropertyWidget +which displays property editor or draws a property in the list if it is not edited. +More exactly, if @ref PropertyLib::PropertyEditor needs to display editor widget, it displays +@ref PropertyLib::PropertyWidget, else it calls @ref PropertyLib::PropertyWidget::drawViewer function. +Custom property widgets should be subclasses of @ref PropertyLib::PropertyWidget. + +To create property widgets at runtime, a factory is used. Factory class is +called @ref PropertyLib::PropertyMachineFactory. Static function @ref PropertyLib::PropertyMachineFactory::getInstance +can be used to obtain the reference to the factory instance. Factory creates and returns +so-called @ref Machine for each registered property type (either predefined or user defined). + +@ref Machine contains @ref PropertyLib::PropertyWidget and a list of "detailed" machines. +Usually only property widget is necessary for a property but there are +complex properties like "Font" for example. We would like to see separate editors +for font family, size, etc. and a button to choose all of these in the dialog. +For that "Font" property, a PropertyWidget with a "choose font" button +and also number of detailed widgets like "font family" combo, etc. can be created. + +\section Examples +A simple example on how to create a property editor and use it with one property list: +\code + PropertyEditor *m_editor = new PropertyEditor(this); + + PropertyList *list = new PropertyList; + list->addProperty("My Group", new Property(Integer, "First Property", + "This is my first property", -5)); + list->addProperty("My Group", new Property(String, "Second Property", + "This is my second property", "Hello")); + list->addProperty(new Property(Color, "Third Property", + "This is my third property", QColor("green"))); + + m_editor->populateProperties(*list); +\endcode + +More advanced example with property accessors and list intersection: +\code + PropertyEditor *m_editor = new PropertyEditor(this); + + PropertyList *list = new PropertyList; + list->addProperty("My Group", new Property(Integer, "First Property", + "This is my first property", -5)); + list->addProperty("My Group", new Property(String, "Second Property", + "This is my second property", "Hello")); + list->addProperty(new Property(Color, "Third Property", + "This is my third property", QColor("green"))); + + PropertyList *list2 = new PropertyList; + list2->addProperty("My Group", new Property(Integer, "First Property", + "This is my first property", -7)); + list2->addProperty("My Group", new Property(String, "Second Property", + "This is my second property", "Hello")); + list2->addProperty(new Property(String, "Third Property", + "This is my third property", "green")); + + PropertyAccessor *ac = list->intersect(*list2); + + m_editor->populateProperties(ac); +\endcode +In this example only properties named "First Property" and "Second Property" will be shown in editor. +"Third Property" has different types in list and list2 and will not be included in intersection. + +*/ diff --git a/doc/api/propeditor1.png b/doc/api/propeditor1.png new file mode 100644 index 00000000..854b91f6 Binary files /dev/null and b/doc/api/propeditor1.png differ diff --git a/doc/api/propeditor2.png b/doc/api/propeditor2.png new file mode 100644 index 00000000..66f8a75b Binary files /dev/null and b/doc/api/propeditor2.png differ diff --git a/doc/extras/Makefile.am b/doc/extras/Makefile.am new file mode 100644 index 00000000..0e7893c4 --- /dev/null +++ b/doc/extras/Makefile.am @@ -0,0 +1,8 @@ +SUBDIRS=w3c + +tocdir = ${kde_datadir}/kdevdocumentation/tocs +toc_DATA = sdl.toc opengl.toc + +#indexdir = ${kde_datadir}/devdoctreeview/indices +#index_DATA = + diff --git a/doc/extras/opengl.toc b/doc/extras/opengl.toc new file mode 100644 index 00000000..efe104ff --- /dev/null +++ b/doc/extras/opengl.toc @@ -0,0 +1,267 @@ + + +OpenGL + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/extras/sdl.toc b/doc/extras/sdl.toc new file mode 100644 index 00000000..947dd09a --- /dev/null +++ b/doc/extras/sdl.toc @@ -0,0 +1,219 @@ + + +SDL + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/extras/w3c/Makefile.am b/doc/extras/w3c/Makefile.am new file mode 100644 index 00000000..19518e8d --- /dev/null +++ b/doc/extras/w3c/Makefile.am @@ -0,0 +1,3 @@ +tocdir = ${kde_datadir}/kdevdocumentation/tocs +toc_DATA = w3c-dom-level2-html.toc w3c-svg.toc w3c-uaag10.toc + diff --git a/doc/extras/w3c/w3c-dom-level2-html.toc b/doc/extras/w3c/w3c-dom-level2-html.toc new file mode 100644 index 00000000..f3540ff1 --- /dev/null +++ b/doc/extras/w3c/w3c-dom-level2-html.toc @@ -0,0 +1,70 @@ + + +Document Object Model (DOM) Level 2 HTML Specification + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +       + + + + + + + + + + diff --git a/doc/extras/w3c/w3c-svg.toc b/doc/extras/w3c/w3c-svg.toc new file mode 100644 index 00000000..a53e34fc --- /dev/null +++ b/doc/extras/w3c/w3c-svg.toc @@ -0,0 +1,1446 @@ + + +Scalable Vector Graphics (SVG) 1.1 Specification + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/extras/w3c/w3c-uaag10.toc b/doc/extras/w3c/w3c-uaag10.toc new file mode 100644 index 00000000..08f90cc9 --- /dev/null +++ b/doc/extras/w3c/w3c-uaag10.toc @@ -0,0 +1,69 @@ + + +User Agent Accessibility Guidelines 1.0 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/kde_app_devel/Makefile.am b/doc/kde_app_devel/Makefile.am new file mode 100644 index 00000000..41691557 --- /dev/null +++ b/doc/kde_app_devel/Makefile.am @@ -0,0 +1,3 @@ +KDE_LANG = en +KDE_DOCS = AUTO + diff --git a/doc/kde_app_devel/appwizard.png b/doc/kde_app_devel/appwizard.png new file mode 100644 index 00000000..adbadb35 Binary files /dev/null and b/doc/kde_app_devel/appwizard.png differ diff --git a/doc/kde_app_devel/index.docbook b/doc/kde_app_devel/index.docbook new file mode 100644 index 00000000..5b721135 --- /dev/null +++ b/doc/kde_app_devel/index.docbook @@ -0,0 +1,1549 @@ + +KDevelop"> + + + +]> + + + + +The &kdevelop; Programming Handbook + +2002-12-05 +2.0 + + + +Ralf +Nolden +
Ralf.Nolden@post.rwth-aachen.de
 + + +Caleb +Tennis +
caleb@aei-tech.com
 + + + + +1999 +Ralf Nolden + + +2002 +Caleb Tennis + + + + +&FDLNotice; + + +The User Guide to C++ Application Design for the K Desktop Environment (KDE) with +the &kdevelop; IDE + + + +KDE +KDevelop +IDE +development +programming + + + + + +Introduction + +As Unix Systems are becoming more and more popular to even beginners working with computer machines +due to its advantages in regards of stability and functionality, most are somehow disappointed, because +those applications don't have a consistent look and each one behaves different from another. With KDE, +developers have an almost perfect way to create first-class applications for Unix desktop systems to get +a wider user community by the mere quality their applications have to offer. Therefore, KDE becomes more +and more popular as a base for programming design, and developers want to take advantage of the +possibilities that the system has to offer. + + + +What you should know already + +For making the best use of this programming handbook, we assume that you already know about the +C++ programming language; if not, you should make yourself familiar with that first. Information about +C++ is available through various sources either in printed form at your local bookstore or by tutorials +found on the Internet. Knowledge about the design of Graphical User Interfaces is not required, as this +handbook tries to cover the application design for KDE programs, which also includes an introduction into +the Qt toolkit as well as the KDE libraries and the design of User Interfaces. Also, you should have made +yourself comfortable with &kdevelop; by reading The User Manual to &kdevelop;, which contains a descriptive +review of the functionality provided by the IDE. + + + + +About this Handbook + +This handbook has been written to give developers an introduction into KDE application development by +using the KDevelop Integrated Development Environment. + + +The following chapters therefore give an introduction on how to create projects, explains the sourcecode +already generated and shows how to extend the given sources on various topics such as toolbars, menu bars +and view areas. + + +Then the dialogeditor is discussed in detail, explaining how widgets are created and covers widget +properties settings in detail for all provided widgets. + + +Finally, you will learn about several topics that will complete your knowledge in regards of project design +and helps you work out additional issues besides coding such as adding API documentation and extending +online-manuals. + + +In the next chapter + +We'll take a look at the Qt and KDE libraries, showing basic concepts and why things are the way they are. +Also, we will discuss how to create the tutorial applications provided with the Qt toolkit by using +kdevelop;, so beginners can already see first results with a few steps, and thereby will learn how to make +use of some of &kdevelop;'s best features. + + + + +In the following chapters + +You will learn how to: + +create an application with the KAppWizard +What the project skeleton already provides +What the code already create means +How to create your own views +How to extend your application's functionality by dialog, menu bars, and toolbars +How to make your application user friendly by providing help functions +How to write online documentation + + + + + + + +Additional Information + +Additional information about Qt/KDE programming is available by various sources: + +Programming with Qt by Matthias Kalle Dalheimer +The User Manual to KDevelop, provided with the KDevelop IDE +The Online Reference to the Qt library +The KDE Developer web site + + + +Additionally, you should look for help by subscribing to the various mailing lists, whose addresses +are available on the mentioned web sites, and on the Usenet newsgroups dedicated to users of KDE and +Unix Systems as well as about the C and C++ programming language. + + +For obtaining help about the KDevelop IDE, you should send requests to our mailinglist at +kdevelop@kdevelop.org. Mind that the KDevelop team is dedicated to provide the means to enable you to +program applications and therefore is not intended as a technical support team in cases where the +applications you're developing don't work due to implementation errors or misconfigurations of your +operating system. By this, we ask all users to take advantage of the mailinglist in any case you're running +into problems with the use of the IDE itself, as well as for bug reports and suggestions for improving the +functionality of the development environment. + + + + + + +The KDE and Qt Libraries + +The Norwegian company TrollTech (http://www.trolltech.com) +provides a so-called GUI toolkit, named Qt. GUI means "Graphical User Interface", and therefore, Qt-based +applications represent themselves with buttons, windows etc, allowing user input by visualizing the functions +an application provides. Such a toolkit is needed for developing graphical applications that run on the X-Window +interface on Unix Systems, because X does not contain a pre-defined user interface itself. Although other +toolkits are also available to create User Interfaces, Qt offers some technical advantages that make +application design very easy. Additionally, the Qt toolkit is also available for Microsoft Windows systems, +which allows developers to provide their applications for both platforms. + + +The KDE Team (http://www.kde.org) joined together with the goal +to make using Unix Systems more friendly, and decided to use the Qt toolkit for the development of a window +manager on X-Windows, plus a variety of tools included with the KDE packages. The K Desktop Environment +therefore contains the window manager kwm, the file manager kfm and the launch panel kpanel as the main +components plus a variety of first-class utilities and applications. After KDE was out, a lot of developers +turned their eyes towards the new environment and what it has to offer them. The KDE libraries are providing +essential methods and classes that make all applications designed with them look similar and consistent, +so the user has the great advantage that he only has to get accustomed with an application's specific +usage, not with handling dialogs or buttons. Also, KDE programs integrate themselves into the desktop and +are able to interact with the file manager via drag'n drop, offer session management and many more, if all +features offered by the KDE libraries are used. Both, the Qt toolkit and the KDE libraries, are implemented +in the C++ programming language; therefore applications that make use of these libraries are also mostly +written in C++. In the following chapter, we'll make a short trip through the libraries to see what already +is provided and how Qt and KDE applications are created in general. + + +Both, the Qt toolkit and the KDE libraries, are implemented in the C++ programming language; +therefore applications that make use of these libraries are also mostly written in C++. In the following +chapter, we'll make a short trip through the libraries to see what already is provided and how Qt and KDE +applications are created in general. + + + +The Qt GUI Toolkit + +As said, the Qt library is a toolkit that offers graphical elements that are used for creating GUI +applications and are needed for X-Window programming. Additionally, the toolkit offers: + +A complete set of classes and methods ready to use even for non-graphical programming issues +A good solution towards user interaction by virtual methods and the signal/slot mechanism +A set of predefined GUI-elements, called "widgets", that can be used easily for creating the visible elements +Additional completely pre-defined dialogs that are often used in applications such as progress and file dialogs + + + +Therefore knowing the Qt classes is very essential, even if you only want to program KDE-applications. +To have an impression on the basic concept how GUI-applications are constructed and compiled, we'll first +have a look at a sample Qt-only program; then we'll extend it to a KDE program. + + + +The first Qt Application + +As usual, programs in C++ have to contain a main() function, which is the starting point for application +execution. As we want them to be graphically visible in windows and offering user interaction, +we first have to know, how they can show themselves to the user. For an example, we'll have a look +at the first tutorial included with the Qt Online Reference Documentation and explain the basic execution +steps; also why and how the application window appears: + +#include <qapplication.h> +#include <qpushbutton.h> + +int main( int argc, char **argv ) +{ +QApplication a( argc, argv ); + +QPushButton hello( "Hello world!", 0 ); +hello.resize( 100, 30 ); + +a.setMainWidget( &hello ); +hello.show(); +return a.exec(); +} + + + +This application merely paints a window containing a button with "Hello world" as its text. As for +all Qt-based applications, you first have to create an instance of the class QApplication, represented by +variable a. + + +Next, the program creates an instance of the class QPushButton called hello, this will be the button. +The constructor of hello gets a string as a parameter, which is the contents of the widget visible as +the buttons text. + + +Then the resize() method is called on the hello button. This changes the default size a widget +(which is in this case the QPushButton) has when created to the length of 100 pixels and the height of +30 pixels. Finally, the setMainWidget() method is called for a and the show() method for hello. The +QApplication is finally executed by a.exec(), enters the main event loop and waits until it has to return +an integer value to the overlaying Operating System signaling that the application is exited. + + + + +The Reference Documentation for Qt + +Now, let's have a quick look at the reference documentation of the Qt library. To do this, start +&kdevelop; and select "Qt" from the tree in the Documentation tab. The documentation browser opens +and shows you the start page of the Qt reference. This will be your first place to get information +about Qt, it's classes and the available functions they provide. Also, the above program is the first +that is included in the tutorials section. To get to the classes we want to have a look at, +QApplication and QPushButton, select "Alphabetical Class List" +and search for the according names. Follow either of them to have a look at the class documentation. + + +Alternatively, you can use the online documentation from Trolltech's Qt Documentation + + +For QApplication, you will see the constructor and all other methods that this +class provides. If you follow a link, you will get more information about the usage and meaning of the +methods, which is very useful when you sometimes can't detect the correct use or want to have an example. +This also counts for the KDE library documentation, which uses a similar documentation type; therefore +this is almost all you have to know about using the class-references with the documentation browser. + + +Interpretation of the Sample + +Starting with QApplication, you will find all the methods used in our first example: + +the constructor QApplication() +the setMainWidget() method +the exec() method + + + +The interpretation why we use these methods is very simple: + +Create an instance of the class QApplication with the constructor, +so we can make use of the GUI elements provided by Qt +Create a widget which will be the contents of our program window +Set the widget as the main widget for a +Execute the a instance of QApplication + + + +The second object of our program is the pushbutton, an instance of the class QPushButton. +From the two constructors given to create an instance, we used the second: this accepts a text, +which is the label contents of the button; here, it is the string "Hello world!". Then we called the +resize() method to change the size of the button according to it's contents - +the button has to be larger to make the string completely visible. + + +But what about the show() method? Now, you see that like most other widgets, +QPushButton is based on a single inheritance, the documentation says, Inherits +QButton. Follow the link to the QButton class. +This shows you a lot of other widgets that are inherited by QPushButton, +which we'll use later to explain the signal/slot mechanism. Anyway, the show() +method is not listed, therefore, it must be a method that is provided by inheritance as well. The class +that QButton inherits is QWidget. Just follow the link +again, and you will see a whole bunch of methods that the QWidget class provides; including +the show() method. Now we understand what was done in the sample with the button: + +Create an instance of QPushButton, use the second constructor to set the button text +Resize the widget to its contents +Set the widget as the main widget of the QApplication instance a +Tell the widget to display itself on the screen by calling show(), an inherited method from QWidget + + + +After calling the exec() method, the application is visible to the user, +showing a window with the button showing "Hello world!". Note: GUI programs behave somewhat differently +than procedural applications. The main thing here is that the application enters a so-called +"main event loop". This means that the program has to wait for user actions and then react to it, also +that for a Qt application, the program has to be in the main event loop to start the event handling. +The next section tells you in short what this means to the programmer and what Qt offers to process +user events. + + +For already advanced users: The button has no parent declared in the constructor, therefore it +is a top-level widget alone and runs in a local event loop which doesn't need to wait for the main +event loop. See the QWidget class documentation and The KDE Library Reference Guide + + + + + + +User Interaction + +After reading the last sections, you should already know: + +What the Qt-library provides in terms of GUI applications +How a program using Qt is created and +Where and how to find information about classes that you want to use with the documentation browser + + + +Now we'll turn to give the application "life" by processing user events. Generally, the user has two ways +to interact with a program: the mouse and the keyboard. For both ways, a graphical user interface has to +provide methods that detect actions and methods that do something as a reaction to these actions. + + +The Window system therefore sends all interaction events to the according application. The +QApplication then sends them to the active window as a QEvent +and the widgets themselves have to decide what to do with them. A widget receives the event and processes +QWidget::event(QEvent*), which then decides which event has been executed +and how to react; event() is therefore the main event handler. Then, +the event() method passes the event to so-called event filters +that determine what happened and what to do with the event. If no filter signs responsible for the +event, the specialized event handlers are called. Thereby we can decide between: + + +Keyboard events -- TAB and Shift-TAB keys: + +virtual void focusInEvent(QFocusEvent *) +virtual void focusOutEvent(QFocusEvent *) + + + + +All other keyboard input: + +virtual void keyPressEvent(QKeyEvent *) +virtual void keyReleaseEvent(QKeyEvent *) + + + + +Mouse movements: + +virtual void mouseMoveEvent(QMouseEvent *) +virtual void enterEvent(QEvent *) +virtual void leaveEvent(QEvent *) + + + + +Mouse button actions + +virtual void mousePressEvent(QMouseEvent *) +virtual void mouseReleaseEvent(QMouseEvent *) +virtual void mouseDoubleClickEvent(QMouseEvent *) + + + + +Window events containing the widget + +virtual void moveEvent(QMoveEvent *) +virtual void resizeEvent(QResizeEvent *) +virtual void closeEvent(QCloseEvent *) + + + + + + +Note that all event functions are virtual and protected; therefore you can re-implement the events +that you need in your own widgets and specify how your widget has to react. QWidget +also contains some other virtual methods that can be useful in your programs; anyway, it is sufficient +to know about QWidget very well. + + + +Object Interaction by Signals and Slots + +Now we're coming to the most obvious advantages of the Qt toolkit: the signal/slot mechanism. +This offers a very handy and useful solution to object interaction, which usually is solved by +callback functions for X-Window toolkits. As this communication requires a strict programming and +sometimes makes user interface creation very difficult (as referred by the Qt documentation and explained +in Programming with Qt by K.Dalheimer), Troll Tech invented a new system where objects can emit signals +that can be connected to methods declared as slots. For the C++ part of the programmer, he only has to know +some things about this mechanism: + + +the class declaration of a class using signals/slots has to contain the Q_OBJECT macro at the beginning +(without a semicolon); and have to be derved from the QObject class + + +a signal can be emitted by the keyword emit, e.g. emit signal(parameters); from within any member function +of a class that allows signals/slots + + + +all signals used by the classes that are not inherited have to be added to the class declaration by a +signals section + + +all methods that can be connected with a signal are declared in sections with the additional keyword slot, +e.g. public slots: within the class declaration + + +the meta-object compiler moc has to run over the header file to expand the macros and to produce the +implementation (which is not necessary to know). The output files of moc are compiled also by the C++ compiler. + + + + +Another way to use signals without deriving from QObject is to use the +QSignal class- see the reference documentation for more information and example +usage. In the following, we assume you're deriving from QObject. + + +This way, your class is able to send signals anywhere and to provide slots that signals can connect +to. By using the signals, you don't have to care about who's receiving it- you just have to emit the +signal and whatever slot you want to connect to it can react to the emission. Also the slots can be used +as normal methods during implementation. + + +Now, to connect a signal to a slot, you have to use the connect() methods that +are provided by QObject or, where available, special methods that objects provide +to set the connection for a certain signal. + + + +Sample Usage + +To explain the way how to set up object-interaction, we'll take our first example again and extend it by a +simple connection: + +#include <qapplication.h> +#include <qpushbutton.h> + +int main( int argc, char **argv ) +{ +QApplication a( argc, argv ); + +QPushButton hello( "Hello world!" , 0); +hello.resize( 100, 30 ); + +a.setMainWidget( &hello ); + +QObject::connect(&hello, SIGNAL( clicked() ), &a, SLOT( quit() )); + +hello.show(); +return a.exec(); +} + + + +You see, the only addition to give the button more interaction is to use a connect() + method: connect(&hello, SIGNAL( clicked() ), &a, SLOT( quit() )); +is all you have to add. What is the meaning now? The class declaration of QObject says about the +connect() method: + + +bool connect ( const QObject * sender, const char * signal, const QObject * receiver, const char * member ) + + +This means you have to specify a QObject instance pointer that is the sender +of the signal, meaning that it can emit this signal as first parameter; then you have to specify the signal +that you want to connect to. The last two parameters are the receiver object that provides a slot, followed +by the member function which actually is the slot that will be executed on signal emission. + + +By using signals and slots, your program's objects can interact with each other easily without explicitly +depending on the type of the receiver object. You will learn more about using this mechanism for productive +usage later in this handbook. More information about the Signals/Slot mechanism can also be found in +The KDE Library Reference Guide +and the Qt online reference. + + + + + + +What KDE provides + +The KDE 3.x libraries + +The main KDE libraries you'll be using for creating your own KDE applications are: + + +the kdecore library, containing all classes that are non-visible elements to provide application functionality + + +the kdeui library, containing user interface elements like menubars, toolbars, etc. + + +the kfile library, containing the file selection dialogs + + + + +Additionally, for specific solutions KDE offers the following libraries: + + +the kdefx library, containing pixmaps, image effects the KStyle extension to QStyle + + +the khtml library, containing KDE's html component + + +the kjs library, containing KDE's Javascript support + + +the kio library, containing low level access to network files + + +the kparts library, containing support for re-usable embeddable extendable applications + + + + +Next we'll have a look at what is needed to turn out first Qt Application into a KDE one. + + + +Example KDE Application + +In the following, you will see that writing a KDE application is not much more difficult than a +Qt application. For the use of KDE's features, you just have to use some other classes, and you're almost +done. As an example, we'll discuss the changed version of the Qt example from above: + +#include <kapplication.h> +#include <qpushbutton.h> + +int main( int argc, char **argv ) +{ +KApplication a( argc, argv ); + +QPushButton hello( "Hello world!", 0 ); +hello.resize( 100, 30 ); + +a.setTopWidget( &hello ); + +QObject::connect(&hello, SIGNAL( clicked() ), &a, SLOT( quit() )); + +hello.show(); +return a.exec(); +} + + + +You see that first we have changed from QApplication to KApplication +. Further, we had to change the previously used setMainWidget() method +to setTopWidget, which KApplication uses to set the main +widget. That's it! Your first KDE application is ready - you only have to tell the compiler the KDE +include path and the linker to link in the kdecore library with -lkdecore. + + +As you now know what at least the main() function provides generally and how an +application gets visible and allows user and object interaction, we'll go on with the next chapter, +where our first application is made with &kdevelop;. There you can also test everything which was +mentioned before and see the effects. + + +What you should have looked into additionally until now is the reference documentation for Qt, +especially the QApplication, QWidget and QObject + class and the kdecore library documentation for the KApplication class. +The KDE Library Reference handbook +also covers a complete description about the invocation of the QApplication and +KApplication constructors including command-line argument processing. + + + + + + + +Creating New Applications + + +The Application Wizard + +&kdevelop;'s Application Wizard is intended to let you start working on new project with &kdevelop;. Therefore +all of your projects are first created by the wizard, and then you can start building them and extend what is +already provided by the source skeleton. You can choose from several project types according to your project goals: + + +KDE Application Framework: includes source code for a complete frame structre of a standard KDE application + + +QMake Project: Creates an application framework based around Trolltech's qmake configuration system + + +Simple hello world program: Creates a C++ terminal based program with no GUI support + + +A multitude of other program skeletons + + + + +In this chapter we'll see how the Application Wizard can be invoked and what has to be done to generate +a KDE application project. This will also be the initial step of our coverage, where we will create the +initial version of a sample project. For all other project types the steps are usualyl the same, but you +may not have as many options available. + + + + +Invoking the Application Wizard and Project Generation + +Starting the Application Wizard and the First Page + +To start with your KDE application, open &kdevelop;. From the Project menu, selection New Project. The +Application Wizard starts, and you'll see the selection tree on the first page containing available project +types that can be created. Choose the C++ subtree, then KDE, then Application Framework. + + +For our sample project, we are going to create the application KScribble. Enter this as the application +name, and change any other information at the bottom of this screen that may need it. Then, select Next. + + +Application Wizard + + + + +Version control information + +On this screen you have the ability to decide if your project will use a version control system like +CVS. For our sample project we will not use source control, so make sure the selection box reads None +and select Next. + + + +Header and Source Templates + +The next two pages show example headers that will go at the top of each of the header and source files that +you create using &kdevelop;. For now, just leave these as the default, and select Next, then Finish. If the +Finish button is not activated, you haven't set all of the options correct. Use the Back button to return +to earlier menus and correct any mistakes. + + + +Finishing Up + +Upon completion, the Application Wizard should close and the messages window should popup displaying +information about the tasks that &kdevelop; is currently doing. At the end of all of the tasks, you +should see **** Success *****. This means the application framework was successfully loaded. + + + + + +The First Build + +After our project is generated, we'll first make a trip through the source code to get a general understanding +of how the application framework looks. This won't only help us get started, but we'll know where to change +what in later steps. + + +This chapter makes the assumption that you understand the basic navigation of &kdevelop;. Consult the +KDevelop User Manual for information if you need it. + + +The Automake manager shows the project files as follows: + + +Files in our project + + + +Before diving into the sources, we'll let &kdevelop; build an run our new application. To do this, select +Build Project from the Build menu, or press F8. The output window opens and displays output messages during +the compilation phase. + +1 cd /home/caleb/kscribble && WANT_AUTOCONF_2_5=1 WANT_AUTOMAKE_1_6=1 gmake k +2 gmake all-recursive +3 gmake[1]: Entering directory `/home/caleb/kscribble' +4 Making all in doc +5 gmake[2]: Entering directory `/home/caleb/kscribble/doc' +6 Making all in . +7 gmake[3]: Entering directory `/home/caleb/kscribble/doc' +8 gmake[3]: Nothing to be done for `all-am'. +9 gmake[3]: Leaving directory `/home/caleb/kscribble/doc' +10 Making all in en +11 gmake[3]: Entering directory `/home/caleb/kscribble/doc/en' +12 /usr/local/kde3/bin/meinproc --check --cache index.cache.bz2 /home/caleb/kscribble/doc/en/index.docbook +13 gmake[3]: Leaving directory `/home/caleb/kscribble/doc/en' +14 gmake[2]: Leaving directory `/home/caleb/kscribble/doc' +15 Making all in po +16 gmake[2]: Entering directory `/home/caleb/kscribble/po' +17 gmake[2]: Nothing to be done for `all'. +18 gmake[2]: Leaving directory `/home/caleb/kscribble/po' +19 Making all in src +20 gmake[2]: Entering directory `/home/caleb/kscribble/src' +21 source='main.cpp' object='main.o' libtool=no \ +22 depfile='.deps/main.Po' tmpdepfile='.deps/main.TPo' \ +23 depmode=gcc3 /bin/sh /home/caleb/kscribble/admin/depcomp \ +24 g++ -DHAVE_CONFIG_H -I. -I/home/caleb/kscribble/src -I.. -I/usr/local/kde3/include + -I/usr/lib/qt/include -I/usr/X11R6/include -DQT_THREAD_SUPPORT -D_REENTRANT -Wnon-virtual-dtor + -Wno-long-long -Wundef -Wall -pedantic -W -Wpointer-arith -Wmissing-prototypes -Wwrite-strings + -ansi -D_XOPEN_SOURCE=500 -D_BSD_SOURCE -Wcast-align -Wconversion -O2 -fno-exceptions -fno-check-new + -c -o main.o `test -f 'main.cpp' || echo '/home/caleb/kscribble/src/'`main.cpp +25 /usr/lib/qt/bin/moc /home/caleb/kscribble/src/kscribble.h -o kscribble.moc +26 source='kscribble.cpp' object='kscribble.o' libtool=no \ +27 depfile='.deps/kscribble.Po' tmpdepfile='.deps/kscribble.TPo' \ +28 depmode=gcc3 /bin/sh /home/caleb/kscribble/admin/depcomp \ +29 g++ -DHAVE_CONFIG_H -I. -I/home/caleb/kscribble/src -I.. -I/usr/local/kde3/include + -I/usr/lib/qt/include -I/usr/X11R6/include -DQT_THREAD_SUPPORT -D_REENTRANT -Wnon-virtual-dtor + -Wno-long-long -Wundef -Wall -pedantic -W -Wpointer-arith -Wmissing-prototypes -Wwrite-strings + -ansi -D_XOPEN_SOURCE=500 -D_BSD_SOURCE -Wcast-align -Wconversion -O2 -fno-exceptions -fno-check-new + -c -o kscribble.o `test -f 'kscribble.cpp' || echo '/home/caleb/kscribble/src/'`kscribble.cpp +30 kscribble.cpp: In member function `void KScribble::setupActions()' +31 kscribble.cpp:107: warning: unused variable `KAction*custom' +32 /usr/lib/qt/bin/moc /home/caleb/kscribble/src/kscribbleview.h -o kscribbleview.moc +33 source='kscribbleview.cpp' object='kscribbleview.o' libtool=no \ +34 depfile='.deps/kscribbleview.Po' tmpdepfile='.deps/kscribbleview.TPo' \ +35 depmode=gcc3 /bin/sh /home/caleb/kscribble/admin/depcomp \ +36 g++ -DHAVE_CONFIG_H -I. -I/home/caleb/kscribble/src -I.. -I/usr/local/kde3/include + -I/usr/lib/qt/include -I/usr/X11R6/include -DQT_THREAD_SUPPORT -D_REENTRANT -Wnon-virtual-dtor + -Wno-long-long -Wundef -Wall -pedantic -W -Wpointer-arith -Wmissing-prototypes -Wwrite-strings -ansi + -D_XOPEN_SOURCE=500 -D_BSD_SOURCE -Wcast-align -Wconversion -O2 -fno-exceptions -fno-check-new -c + -o kscribbleview.o `test -f 'kscribbleview.cpp' || echo '/home/caleb/kscribble/src/'`kscribbleview.cpp +37 kscribbleview.cpp: In member function `void KScribbleView::print(QPainter*, +38 int, int)': +39 kscribbleview.cpp:79: warning: unused parameter `QPainter*p' +40 kscribbleview.cpp:79: warning: unused parameter `int height' +41 kscribbleview.cpp:79: warning: unused parameter `int width' +42 /usr/lib/qt/bin/moc /home/caleb/kscribble/src/pref.h -o pref.moc +43 source='pref.cpp' object='pref.o' libtool=no \ +44 depfile='.deps/pref.Po' tmpdepfile='.deps/pref.TPo' \ +45 depmode=gcc3 /bin/sh /home/caleb/kscribble/admin/depcomp \ +46 g++ -DHAVE_CONFIG_H -I. -I/home/caleb/kscribble/src -I.. -I/usr/local/kde3/include + -I/usr/lib/qt/include -I/usr/X11R6/include -DQT_THREAD_SUPPORT -D_REENTRANT -Wnon-virtual-dtor + -Wno-long-long -Wundef -Wall -pedantic -W -Wpointer-arith -Wmissing-prototypes -Wwrite-strings + -ansi -D_XOPEN_SOURCE=500 -D_BSD_SOURCE -Wcast-align -Wconversion -O2 -fno-exceptions -fno-check-new + -c -o pref.o `test -f 'pref.cpp' || echo '/home/caleb/kscribble/src/'`pref.cpp +47 /usr/local/kde3/bin/dcopidl /home/caleb/kscribble/src/kscribbleiface.h > kscribbleiface.kidl || + ( rm -f kscribbleiface.kidl ; /bin/false ) +48 /usr/local/kde3/bin/dcopidl2cpp --c++-suffix cpp --no-signals --no-stub kscribbleiface.kidl +49 source='kscribbleiface_skel.cpp' object='kscribbleiface_skel.o' libtool=no \ +50 depfile='.deps/kscribbleiface_skel.Po' tmpdepfile='.deps/kscribbleiface_skel.TPo' \ +51 depmode=gcc3 /bin/sh /home/caleb/kscribble/admin/depcomp \ +52 g++ -DHAVE_CONFIG_H -I. -I/home/caleb/kscribble/src -I.. -I/usr/local/kde3/include + -I/usr/lib/qt/include -I/usr/X11R6/include -DQT_THREAD_SUPPORT -D_REENTRANT -Wnon-virtual-dtor + -Wno-long-long -Wundef -Wall -pedantic -W -Wpointer-arith -Wmissing-prototypes -Wwrite-strings + -ansi -D_XOPEN_SOURCE=500 -D_BSD_SOURCE -Wcast-align -Wconversion -O2 -fno-exceptions -fno-check-new + -c -o kscribbleiface_skel.o `test -f 'kscribbleiface_skel.cpp' || + echo '/home/caleb/kscribble/src/'`kscribbleiface_skel.cpp +53 /bin/sh ../libtool --silent --mode=link --tag=CXX g++ -Wnon-virtual-dtor -Wno-long-long -Wundef -Wall + -pedantic -W -Wpointer-arith -Wmissing-prototypes -Wwrite-strings -ansi -D_XOPEN_SOURCE=500 + -D_BSD_SOURCE -Wcast-align -Wconversion -O2 -fno-exceptions -fno-check-new -o kscribble -R + /usr/local/kde3/lib -R /usr/lib/qt/lib -R /usr/X11R6/lib -L/usr/X11R6/lib -L/usr/lib/qt/lib + -L/usr/local/kde3/lib main.o kscribble.o kscribbleview.o pref.o kscribbleiface_skel.o -lkio +54 source='kscribble_client.cpp' object='kscribble_client.o' libtool=no \ +55 depfile='.deps/kscribble_client.Po' tmpdepfile='.deps/kscribble_client.TPo' \ +56 depmode=gcc3 /bin/sh /home/caleb/kscribble/admin/depcomp \ +57 g++ -DHAVE_CONFIG_H -I. -I/home/caleb/kscribble/src -I.. -I/usr/local/kde3/include + -I/usr/lib/qt/include -I/usr/X11R6/include -DQT_THREAD_SUPPORT -D_REENTRANT -Wnon-virtual-dtor + -Wno-long-long -Wundef -Wall -pedantic -W -Wpointer-arith -Wmissing-prototypes -Wwrite-strings + -ansi -D_XOPEN_SOURCE=500 -D_BSD_SOURCE -Wcast-align -Wconversion -O2 -fno-exceptions -fno-check-new + -c -o kscribble_client.o `test -f 'kscribble_client.cpp' || echo + '/home/caleb/kscribble/src/'`kscribble_client.cpp +58 /bin/sh ../libtool --silent --mode=link --tag=CXX g++ -Wnon-virtual-dtor -Wno-long-long -Wundef + -Wall -pedantic -W -Wpointer-arith -Wmissing-prototypes -Wwrite-strings -ansi -D_XOPEN_SOURCE=500 + -D_BSD_SOURCE -Wcast-align -Wconversion -O2 -fno-exceptions -fno-check-new -o kscribble_client -R + /usr/local/kde3/lib -R /usr/lib/qt/lib -R /usr/X11R6/lib -L/usr/X11R6/lib -L/usr/lib/qt/lib + -L/usr/local/kde3/lib kscribble_client.o -lkdecore +59 gmake[2]: Leaving directory `/home/caleb/kscribble/src' +60 gmake[2]: Entering directory `/home/caleb/kscribble' +61 gmake[2]: Nothing to be done for `all-am'. +62 gmake[2]: Leaving directory `/home/caleb/kscribble' +63 gmake[1]: Leaving directory `/home/caleb/kscribble' +64 *** Success *** + + + +As you can see, we've put line numbers in front of each line which won't appear on your output but it makes it +easier to describe what is happening during the build. First of all, gmake works recursively. This means +that it starts from the directory it is invoked and goes into the subdirectories first, one at a time, then +returns to the directory it was started, processes it, then finishes. + + +Our first line of interest is 24. Notice on this line that g++, which is our C++ compiler, gets called by make +to compile the first source code file in our project - in this case main.cpp. Many extra command line options +are also being used with the g++ compiler; some of which are defaults and some of which can be configured +via &kdevelop;. + + +Before the next file (kscribble.cpp, line 29) is compiled, the moc (meta object compiler) is first +invoked on kscribble.h (line 25). This is because KScribble classes use signals/slots, so the +Q_OBJECT macro must be expanded, and the moc does this for us. The resultant file, kscribble.moc, is +used by kscribble.cpp via an #include statement inside of the file. + + + + +The source skeleton + +To conceptualize how a KDE application works, we'll first have a very close look at the source +skeleton already provided by the Application Wizard. As we already saw, we're having a set of source +and header files that build the initial code for the application and make it ready-to-run. Therefore, +the easiest way to explain the code is to follow the implementation line by line as it is processed +during executing the program until it enters the main event loop and is ready to accept user input. +Then, we'll have a look at the functionality that enables user interaction and how certain things work. +This is probably the best way to explain the framework and, as it is similar to almost all KDE +applications, will enable you to read source codes from other projects as well; additionally, you will +know where to change what part of the code to make your applications behave the way they are designed for. + + + +The main() function + +As the application begins its execution with entering the main() function, +this will be the start for our code examination. The main() function of +KScribble is implemented in the file main.cpp and can also be found using the Class Browser +by selecting the "Global Functions" folder. + +1 int main(int argc, char **argv) +2 { +3 KAboutData about("kscribble", I18N_NOOP("KScribble"), version, description, +4 KAboutData::License_GPL, "(C) 2002 Your Name", 0, 0, "you@you.com"); +5 about.addAuthor( "Your Name", 0, "you@you.com" ); +6 KCmdLineArgs::init(argc, argv, &about); +7 KCmdLineArgs::addCmdLineOptions(options); +8 KApplication app; +9 +10 // register ourselves as a dcop client +11 app.dcopClient()->registerAs(app.name(), false); +12 +13 // see if we are starting with session management +14 if (app.isRestored()) +15 RESTORE(KScribble) +16 else +17 { +18 // no session.. just start up normally +19 KCmdLineArgs *args = KCmdLineArgs::parsedArgs(); +20 if (args->count() == 0) +21 { +22 KScribble *widget = new KScribble; +23 widget->show(); +24 } +25 else +26 { +27 int i = 0; +28 for (; i < args->count(); i++) +29 { +30 KScribble *widget = new KScribble; +31 widget->show(); +32 widget->load(args->url(i)); +33 } +34 } +35 args->clear(); +36 } +37 +38 return app.exec(); +39 } + + + +Now, what happens first is the usual creation of a KApplication object, but we've +added some KDE methods that set program and author information for this application. + + + +User Application Start + +... (not written yet) + + + +The Constructor + +Let's have a look at the constructor and see how this instance is called + +1 KScribble::KScribble() +2 : KMainWindow( 0, "KScribble" ), +3 m_view(new KScribbleView(this)), +4 m_printer(0) +5 { +6 // accept dnd +7 setAcceptDrops(true); +8 +9 // tell the KMainWindow that this is indeed the main widget +10 setCentralWidget(m_view); +11 +12 // then, setup our actions +13 setupActions(); +14 +15 // and a status bar +16 statusBar()->show(); +17 +18 // allow the view to change the statusbar and caption +19 connect(m_view, SIGNAL(signalChangeStatusbar(const QString&)), +20 this, SLOT(changeStatusbar(const QString&))); +21 connect(m_view, SIGNAL(signalChangeCaption(const QString&)), +22 this, SLOT(changeCaption(const QString&))); +23 +24 } + + + +Notice that KScribble inherits the KMainWindow class - a +commonly used base class for KDE applications. We initialize a class called KScribbleView +as our central widget, create a KStatusBar via the statusBar() +method (line 16), and connect some signals and slots together. + + + + + + + +Application View Design + +Introduction + +When developing an application with a graphical user interface, the main work takes place in +providing a so-called "view" for the application. A view generally is a widget that displays the data +of a document and provides methods to manipulate the document contents. This can be done by the user via +the events he emits by the keyboard or the mouse; more complex operations are often processed by toolbars +and menubars which interact with the view and the document. The statusbar then provides information about +the document, view or application status. As an example, we look at how an editor is constructed and where +we can find which part. + + +An editor generally is supposed to provide an interface to view and/or change the contents of a text +document for the user. If you start Kate, you see the visual interface as the following: + + +The menubar: providing complex operations as well as opening, saving and closing files and +exiting the application. + + +The toolbar: offers icons which allow quicker access for most needed functions, + + +The statusbar: displays the status of the cursor position by the current row and column, + + +The view in the center of the window, displaying a document and offering a cursor connected to +the keyboard and the mouse to operate on the data. + + + + +Now it's easy to understand that a view is the most unique part of the application and the design +of the view decides about the usability and acceptability of an application. This means that one of +the first steps in development is to determine the purpose of the application and what kind of view +design would match best to allow any user to work with the application with a minimum of work +learning how to handle the user interface. + + +For some purposes like text editing and displaying HTML files, views are provided by the Qt and KDE +libraries; we will discuss certain aspects of these high-level widgets in the next section. +But for most applications new widgets have to be designed and implemented. It is that what makes a +programmer also a designer and where his abilities on creativity are asked. Nevertheless, you should +watch for intuitivity first. Remember, a lot of users won't accept an application that isn't: + + +graphically nice. + + +offering a lot of features + + +easy to handle + + +fast to learn how to use it + + + + +Needless to say that stability is a major design goal. Nobody can prevent bugs, but a minimum can +be reached at least by clever design goals and wide use of object-oriented design. C++ makes programming +a joy if you know how to exploit it's capabilities- inheritance, information hiding and reusablitity of +already existing code. + + +When creating a KDE or Qt project, you always have to have a view that inherits QWidget, either by +direct inheritance or because the library widget you want to use inherits QWidget. Therefore, the +Application Wizard already constructed a view that is an instance of a class yourappView, which +inherits QWidget already. + + +This chapter therefore describes how to use library widgets for creating views of KDE or +Qt applications that are generated with &kdevelop;, then we look at the libraries and what kind of +views are already offered. + + + +Using Library Views + +When your application design has been set up, you first should look for already existing code that +will make your life a lot easier. A part of this search is to look for a widget that can be used as +a view or at least as a part of it; either directly or by inheritance. The KDE and Qt libraries already +contain a set of widgets that can be used for this purpose. To use them, you have two options: + + +Remove the new view class and create an instance of a library widget; then set this as the view, + + +Change the inheritance of the provided view class to the class of the library widget to use. + + + + +In either way, it is important to know that if the application framework is currently not linked +against the library that contains the widget, the linker will fail. After you decided to use a +certain widget, look for the library to link to; then open "Project"->"Options" from the &kdevelop; +menubar. Switch to the "Linker Options" page and look for the checkmarks indicating the libraries +that are currently used. If the library of your view widget is already checked, you can leave the +project options untouched and start doing the necessary changes due to your choice. If not, and the +linker options offer to add the library by a check box, check it and press "OK" to leave the project +options dialog again. In any other case, add the library in the edit line below with the -l option. +For libraries that your application has to search for before preparing the Makefiles by the +configure script on the end-user machine, add the according search macro to the configure.in file +located at the root directory of your project and add the macro to the edit line. Mind that you have +to run "Build"->"Autoconf and automake" and "Build"->"Configure" before the Makefiles contain the +correct expansion for the library macro. + + +Also, if the include files for the library to add are not in the current include path +(which can be seen by the -I options in the output window on "Make"), you have to add the path to the +Project Options dialog -"Compiler Options" page with the -I option or the according automake macro at +the edit line for "Additional Options". + + +Qt Views + +Looking at the first page of the Qt online documentation, you will find a link to +"Widget Screenshots" where you can have a look at how the widgets Qt contains look like. +These are ready to use and can be combined together to form complex widgets to create application +views or dialogs. In the following, we'll discuss some of these which are very usable for creating +application views, but keep in mind that the KDE libraries sometimes contain other widgets for the +same purpose; those will be reviewed in the next section. + + +Here are a set of hints for what purpose you could use which Qt component: + + +If your view area isn't big enough to display all your data, the user must be enabled to scroll +over the document with bars on the left and bottom of the view. For this, Qt provides the class +QScrollView, which offers a scrollable child area. As explained, you could +inherit your own widget from QScrollView or use an instance to manage your +document's view widget. + + +to create a ScrollView yourself, inherit the View widget from QWidget +and add vertical and horizontal QScrollBars . +(This is done by KDE`s KHTMLView widget.) + + +For text processing, use QTextEdit. This class provides a complete +text editor widget that is already capable to cut, copy and paste text and is managed by a scrollview. + + +Use QTable to display data that is arranged in a table. +As QTable is managed by scrollbars as well, it offers a good solution for +table calculation applications. + + +To display two different widgets or two widget instances at the same time, use QSplitter +. This allows to tile views by horizontal or vertical dividers. +KMail is a good example what this would look like- the main view is separated by a +splitter vertically, the right window then is divided again horizontally. + + +QListView displays information in a list and tree. +This is useful for creating file trees or any other hierarchical information you want to interact with. + + + + +You see that Qt alone offers a whole set of widgets which are ready to use so you don't have to invent +new solutions if these match your needs. The sideffect when using standard widgets is that users already +know how to handle them and only have to concentrate on the displayed data. + + + +KDE Views + +The KDE libraries were invented to make designing applications for the K Desktop Environment easier +and capable of more functionality than what Qt alone is offering. The kdeui library offers: + + +KListView: a more powerful version of QListView + + +KIconView: a graphical viewer of icon files + + + + +The khtml library, on the other hand, offers a complete HTML-interpreting widget that is ready to use. +It is scrollable already, so you don't even have to take care for that. A possible use could be to +integrate it as a preview widget for an HTML editor; used by applications such as Konqueror to display HTML files. + + + + +Creating your own Views + +Not yet written + + + + + +Configuring Menubars and Toolbars + +Introduction + +Menubars and toolbars are one of the most important parts of an application to provide methods to +work with a document structure. As a general rule, you should make all functions available by the menubar. +Those methods that should not be available at a current stage of the application process should be +disabled. + + +Further, an application can only contain one menubar, but several toolbars. +Toolbars on the other hand should contain only the most frequently used commands by pixmap +icons or provide quick access methods like combos to select values. + + + +How does it work? + +Our application inherits the KMainWindow class, which automatically handles creating +a menu bar and tool bars for us. In the KScribble::setupActions() method there is +a call to KMainWindow::createGUI(). This method loads a resource file, in this +case kscribbleui.rc, to initialize menus at startup. Note that kscribbleui.rc is listed as one of the +project files in the Automake Manager. Opening that file up reveals this: + +1 <!DOCTYPE kpartgui SYSTEM "kpartgui.dtd"> +2 <kpartgui name="kscribble" version="1"> +3 <MenuBar> +4 <Menu name="custom"><text>C&ustom</text> +5 <Action name="custom_action" /> +6 </Menu> +7 </MenuBar> +8 </kpartgui> + + + +Explanation... + + +Another way to modify the contents of the menu and tool bars is to directly manipulate them through the +methods provided by their class. For example, the menuBar() method returns the +KMenuBar widget that the menubar for our program. Looking at the documentation for +KMenuBar and its inheritor class QMenuBar, you will find +a large number of insertItem() methods which allow you to add items to the +menu bar. + + +KMainWindow's methods statusBar() and +toolBar() will also provide you with applicable widgets. + + + +Keyboard Accelerator Configuration + +A very professional thing you should always add to your application are keyboard accelerators. +Those are mainly used by experienced users that want to work fast with their applications and +are willing to learn shortcuts. For this, the KDE libraries provide the class +KAction, which provides the keyboard accelerator keys and access to global configured +standard keyboard accelerators. + + +By default, frame applications generated by &kdevelop; only use standard keyboard accelerators +such as F1 for accessing online-help, Ctrl+N for New File etc. + + +If your application contains a lot of accelerators, you should make them configurable +by an Options-menu; either it could be combined with other application configuration in a QWidget +or stand alone. The KDE library already provides a KKeyChooser +for use in tab dialogs, whereas KKeyDialog provides a ready-to use +key-configuration dialog. + + + + + + + +Help Functions + +Introduction + +A very important part of the development process is to provide help functionality to the user +wherever possible. Most developers tend to delay this, but you should remember that a normal user +isn't necessarily a Unix expert. He may come from the the dark side of computer software usage offering +all sweets that a user may need to work himself into using an application even without ever touching the +manuals. Therefore, the KDE and Qt library provide all means usually considered making an application +professional in the eyes of the normal user by help functions that are ready to use. +Within the application, those are: + +Tool-Tips +Statusbar help +What's this...? buttons + + +Additionally, the application should provide means to access a HTML-based online manual directly +using the standard help key F1. This context based help system is provided automatically through the +KMainWindow class, though as the author you must provide the content. + + +As &kdevelop; also offers all types of help as well as the KDE framework generated by the +application wizard already contains support for this, this chapter will help you find out where +and how to add your help functionality. + +During the development of your application you should try to be consistent whatever you're doing; +therefore you should do the necessary steps directly while extending the code. This will prevent you +from diving into the code again and figuring out what your application does or what you intended by +certain parts of the code. + + + + +Tool-Tips + +A very easy means of providing help are tool-tips. Those are small help messages popping up while +the user moves the mouse over a widget that provides a tool-tip and disappears when the mouse moves away. +The most popular usage of tool-tips is made in toolbars where your tool-tips should be kept as small +as possible because toolbars can be configured to display their contents in various ways: +either displaying the button, button with text on the right, button with text below, text only. +This possibility should be made configurable by the user, but isn't a must-be. The text is shown +as a tool-tip anyway and a toolbar usually consists of buttons and other widgets like lineedits and +combo boxes. For a complete reference, see the KToolBar class reference located +in the kdeui library. + + +As an example, we have a look at the "New File" button in a generic application: + + +There, the part i18n("New File") provides a tool-tip message. It is enclosed by the i18n() +macro provided by kapp.h to translate the tool-tip towards the currently selected language. + + +Tool-tips can also be added to any custom widget by using the QToolTip +provided by Qt. An example of that would be: + + + +Extending the Statusbar + +As the applications that inherit KMainWindow contain a statusbar as well, +it also offers a set of statusbar messages already for all menu and toolbar items. A statusbar +help message is a short message that extends the meaning of a tool-tip or can be seen as a replacement +for a tool-tip over menubar items and is (as the name suggests) displayed in the statusbar when the user +enters a menu and highlights the menu entry. + + + +The <guibutton>What's This...?</guibutton> Button + +The What's This...? button provides help windows with the intention +that the user wants to get help about a certain widget within the working view or a toolbar item. +It is placed in the toolbar and gets activated once the user hits the button. The cursor changes +to an arrow cursor with a question mark like the button itself looks like. The the user can press on +a visible widget item and gets a help window. As an exercise, you could try this behavior with the +What's this...? button within &kdevelop;. + + +To add the What's This...? help to one of your widgets, use the static method +QWhatsThis::add(QWidget *widget, const QString &text) + + + + + +Documentation + +Introduction + +Due to the fact that projects often lack a complete set of user documentation, +all &kdevelop; projects contain a pre-build handbook that can be easily adapted; +therefore fulfiling another goal of KDE: providing enough online-help to support users that +are not familiar with an application. This chapter therefore introduces you on how to extend +the provided documentation template and what you have to do to make it available to the user. + + + +User Documentation + +The documentation for your project lies in projectdir/doc/en, or perhaps another directory if English +isn't your native language. Therein lies a file, index.docbook, in which the documentation is stored. +The format for editing this file is explained on +KDE's documentation website. + + + +Programmer Documentation + +Another important part of the documentation is including a descriptive help for your class interfaces. +This will allow you and other programmers to use your classes by reading the HTML class documentation +that can be created with KDoc. &kdevelop; supports the use of KDoc completely by creating the +KDE-library documentation, also your application frameworks are already documented. To work yourself +into the provided code, it would be a good start to read the included documentation online. +The following describes what to do to get the API documentation, where &kdevelop; helps you add it +and what kind of special tags KDoc provides. + + + + + +Internationalization + +Introdction + +i18n is an internationalization system that is used to offer internationalized versions of an +application or project. The difficulty with writing applications is that they only support the +language they originally are composed with; visually this can be seen on labels, menu entries and the +like. The goal of the internationalization is to provide applications and library functions in the +language of the user; therefore enabling users that are not native speakers the original language to make +use of the provided functionality and feel more comfortable. + + + + + + +Credits + + +(... to be written ...) + + + + + + + +Bibliography + + + +<ulink url="info://make/Top">GNU Make Manual</ulink> + +Richard M.Stallman +RolandMcGrath + + + + +<ulink url="info://automake/Top">GNU Automake</ulink> + +DavidMacKenzie +TomTromey + + + + +<ulink url="info://autoconf/Top">GNU Autoconf</ulink> + +DavidMacKenzie +BenElliston + + + + +<ulink url="info://gcc/Top">Using the GNU Compiler Collection</ulink> +Richard M.Stallman + + + +<ulink url="info://libtool/Top">GNU Libtool</ulink> + +GordonMatzigkeit +AlexandreOliva +ThomasTanner +Gary V.Vaughan + + + + +GNU Autoconf, Automake, and Libtool +1st edition +October 2000 + +Gary V.Vaughan +BenElliston +TomTromey +Ian LanceTaylor + +New Riders Publishing +ISBN 1578701902 + + + + +Advanced Programming in the UNIX(R) Environment +1st edition +June 1992 +W. RichardStevens +Addison-Wesley Pub Co +ISBN 0201563177 + + + +Thinking in C++, Volume 1: Introduction to Standard C++ +2nd Edition +April 15, 2000 +BruceEckel +Prentice Hall +ISBN 0139798099 + + + +Open Source Development with CVS +2nd Edition +October 12, 2001 + +KarlFogel +MosheBar + +The Coriolis Group +ISBN 158880173X + + + +Programming PHP +1st edition +March 2002 + +RasmusLerdorf +KevinTatroe + +O'Reilly & Associates +ISBN 1565926102 + + + +Programming Python +2nd Edition +March 2001 +MarkLutz +O'Reilly & Associates +ISBN 0596000855 + + + +Gui Programming With Python : Using the Qt Toolkit +Bk&Cd-r edition +January 2002 +BoudewijnRempt +Opendocs Llc +ISBN 0970033044 + + + +Programming Perl +The Camel book +3rd Edition +July 2000 + +LarryWall +TomChristiansen +JonOrwant + +O'Reilly & Associates +ISBN 0596000278 + + + +Learning Perl +The Lama book +3rd Edition +July 15, 2001 + +Randal L.Schwartz +TomPhoenix + +O'Reilly & Associates +ISBN 0596001320 + + + + +&underFDL; + + + + + diff --git a/doc/kde_app_devel/kscribblefiles.png b/doc/kde_app_devel/kscribblefiles.png new file mode 100644 index 00000000..1591b3cf Binary files /dev/null and b/doc/kde_app_devel/kscribblefiles.png differ diff --git a/doc/kdearch/Makefile.am b/doc/kdearch/Makefile.am new file mode 100644 index 00000000..171f575c --- /dev/null +++ b/doc/kdearch/Makefile.am @@ -0,0 +1,2 @@ +KDE_LANG = en +KDE_DOCS = AUTO diff --git a/doc/kdearch/affine-general.png b/doc/kdearch/affine-general.png new file mode 100644 index 00000000..8e59d5e5 Binary files /dev/null and b/doc/kdearch/affine-general.png differ diff --git a/doc/kdearch/affine-rotate.png b/doc/kdearch/affine-rotate.png new file mode 100644 index 00000000..7192ed9c Binary files /dev/null and b/doc/kdearch/affine-rotate.png differ diff --git a/doc/kdearch/affine-scale.png b/doc/kdearch/affine-scale.png new file mode 100644 index 00000000..0b52fd4c Binary files /dev/null and b/doc/kdearch/affine-scale.png differ diff --git a/doc/kdearch/affine-shear.png b/doc/kdearch/affine-shear.png new file mode 100644 index 00000000..1ed5fbd8 Binary files /dev/null and b/doc/kdearch/affine-shear.png differ diff --git a/doc/kdearch/affine-translate.png b/doc/kdearch/affine-translate.png new file mode 100644 index 00000000..87265e30 Binary files /dev/null and b/doc/kdearch/affine-translate.png differ diff --git a/doc/kdearch/brushstyles.png b/doc/kdearch/brushstyles.png new file mode 100644 index 00000000..b6df50ca Binary files /dev/null and b/doc/kdearch/brushstyles.png differ diff --git a/doc/kdearch/canvas.png b/doc/kdearch/canvas.png new file mode 100644 index 00000000..dd83dae9 Binary files /dev/null and b/doc/kdearch/canvas.png differ diff --git a/doc/kdearch/capflat.png b/doc/kdearch/capflat.png new file mode 100644 index 00000000..5e1c92ce Binary files /dev/null and b/doc/kdearch/capflat.png differ diff --git a/doc/kdearch/capround.png b/doc/kdearch/capround.png new file mode 100644 index 00000000..0e66eaac Binary files /dev/null and b/doc/kdearch/capround.png differ diff --git a/doc/kdearch/capsquare.png b/doc/kdearch/capsquare.png new file mode 100644 index 00000000..35724a72 Binary files /dev/null and b/doc/kdearch/capsquare.png differ diff --git a/doc/kdearch/index.docbook b/doc/kdearch/index.docbook new file mode 100644 index 00000000..b1a40091 --- /dev/null +++ b/doc/kdearch/index.docbook @@ -0,0 +1,3337 @@ + + + +]> + + + + +KDE Architecture Overview + + + + + + +Bernd +Gehrmann +
bernd@kdevelop.org
 + + + + +2001 +2002 +Bernd Gehrmann + + +&FDLNotice; + + +This documentation gives an overview of the KDE Development Platform + + + +KDE +architecture +development +programming + + + + + +Library structure + + +Libraries by name + + + + +kdecore + +The kdecore library is the basic application framework for every KDE based +program. It provides access to the configuration system, command line +handling, icon loading and manipulation, some special kinds inter-process +communication, file handling and various other utilities. + + + + +kdeui + +The kdeui library provides many widgets and standard +dialogs which Qt doesn't have or which have more features than their Qt +counterparts. It also includes several widgets which are subclassed +from Qt ones and are better integrated with the KDE desktop by +respecting user preferences. + + + + +kio + +The kio library contains facilities for asynchronous, +network transparent I/O and access to mimetype handling. It also provides the +KDE file dialog and its helper classes. + + + + +kjs + +The kjs library provides an implementation of JavaScript. + + + + +khtml + +The khtml library contains the KHTML part, a HTML browsing +widget, DOM API and parser, including interfaces to Java and JavaScript. + + + + + + + + + +Grouped classes + + +Core application skeleton - classes needed by almost every application. + + + + + +<ulink url="kdeapi:kdecore/KApplication">KApplication</ulink> + +Initializes and controls a KDE application. + + + + +<ulink url="kdeapi:kdecore/KUniqueApplication">KUniqueApplication</ulink> + +Makes sure only one instance of an application can run simultaneously. + + + +<ulink url="kdeapi:kdecore/KAboutData">KAboutData</ulink> + +Holds information for the about box. + + + +<ulink url="kdeapi:kdecore/KCmdLineArgs">KCmdLineArgs</ulink> + +Command line argument processing. + + + + + + +Configuration settings - access to KDE's hierarchical configuration +database, global settings and application resources. + + + + +<ulink url="kdeapi:kdecore/KConfig">KConfig</ulink> + +Provides access to KDE's configuration database. + + + +<ulink url="kdeapi:kdecore/KSimpleConfig">KSimpleConfig</ulink> + +Access to simple, non-hierarchical configuration files. + + + +<ulink url="kdeapi:kdecore/KDesktopFile">KDesktopFile</ulink> + +Access to .desktop files. + + + +<ulink url="kdeapi:kdecore/KGlobalSettings">KGlobalSettings</ulink> + +Convenient access to not application-specific settings. + + + + + + +File and URL handling - decoding of URLs, temporary files etc. + + + + +<ulink url="kdeapi:kdecore/KURL">KURL</ulink> + +Represents and parses URLs. + + + +<ulink url="kdeapi:kdecore/KTempFile">KTempFile</ulink> + +Creates unique files for temporary data. + + + +<ulink url="kdeapi:kdecore/KSaveFile">KSaveFile</ulink> + +Allows to save files atomically. + + + + + + +Interprocess communication - DCOP helper classes and subprocess invocation. + + + + +<ulink url="kdeapi:kdecore/KProcess">KProcess</ulink> + +Invokes and controls child processes. + + + +<ulink url="kdeapi:kdecore/KShellProcess">KShellProcess</ulink> + +Invokes child processes via a shell. + + + +<ulink url="kdeapi:kdesu/PtyProcess">PtyProcess</ulink> + +Communication with a child processes through a pseudo terminal. + + + +<ulink url="kdeapi:kdecore/KIPC">KIPC</ulink> + +Simple IPC mechanism using X11 ClientMessages. + + + +<ulink url="kdeapi:dcop/DCOPClient">DCOPClient</ulink> + +DCOP messaging. + + + +<ulink url="kdeapi:kdecore/KDCOPPropertyProxy">KDCOPPropertyProxy</ulink> + +A proxy class publishing Qt properties through DCOP. + + + +<ulink url="kdeapi:kdeui/KDCOPActionProxy">KDCOPActionProxy</ulink> + +A proxy class publishing a DCOP interface for actions. + + + + + + +Utility classes - memory management, regular expressions, string manipulation, +random numbers + + + + +<ulink url="kdeapi:kdecore/KRegExp">KRegExp</ulink> + +POSIX regular expression matching. + + + +<ulink url="kdeapi:kdecore/KStringHandler">KStringHandler</ulink> + +An extravagant interface for string manipulation. + + + +<ulink url="kdeapi:kdecore/KZoneAllocator">KZoneAllocator</ulink> + +Efficient memory allocator for large groups of small objects. + + + +<ulink url="kdeapi:kdecore/KRandomSequence">KRandomSequence</ulink> + +Pseudo random number generator. + + + + + + +Keyboard accelerators - classes helping to establish consistent key bindings +throughout the desktop. + + + + +<ulink url="kdeapi:kdecore/KAccel">KAccel</ulink> + +Collection of keyboard shortcuts. + + + +<ulink url="kdeapi:kdecore/KStdAccel">KStdAccel</ulink> + +Easy access to the common keyboard shortcut keys. + + + +<ulink url="kdeapi:kdecore/KGlobalAccel"></ulink> + +Collection of system-wide keyboard shortcuts. + + + + + + +Image processing - icon loading and manipulating. + + + + +<ulink url="kdeapi:kdecore/KIconLoader">KIconLoader</ulink> + +Loads icons in a theme-conforming way. + + + +<ulink url="kdeapi:kdecore/KIconTheme">KIconTheme</ulink> + +Helper classes for KIconLoader. + + + +<ulink url="kdeapi:kdecore/KPixmap">KPixmap</ulink> + +A pixmap class with extended dithering capabilities. + + + +<ulink url="kdeapi:kdeui/KPixmapEffect">KPixmapEffect</ulink> + +Pixmap effects like gradients and patterns. + + + +<ulink url="kdeapi:kdeui/KPixmapIO">KPixmapIO</ulink> + +Fast QImage to QPixmap conversion. + + + + + + +Drag and Drop - drag objects for colors and URLs. + + + + +<ulink url="kdeapi:kdecore/KURLDrag">KURLDrag</ulink> + +A drag object for URLs. + + + +<ulink url="kdeapi:kdeui/KColorDrag">KColorDrag</ulink> + +A drag object for colors. + + + +<ulink url="kdeapi:kdecore/KMultipleDrag">KMultipleDrag</ulink> + +Allows to construct drag objects from several others. + + + + + + +Auto-Completion + + + + +<ulink url="kdeapi:kdecore/KCompletion">KCompletion</ulink> + +Generic auto-completion of strings. + + + +<ulink url="kdeapi:kio/KURLCompletion">KURLCompletion</ulink> + +Auto-completion of URLs. + + + +<ulink url="kdeapi:kio/KShellCompletion">KShellCompletion</ulink> + +Auto-completion of executables. + + + + + + +Widgets - widget classes for list views, rules, color selection etc. + + + + +<ulink url="kdeapi:kdeui/KListView">KListView</ulink> + +A variant of QListView that honors KDE's system-wide settings. + + + +<ulink url="kdeapi:kdeui/KListView">KListBox</ulink> + +A variant of QListBox that honors KDE's system-wide settings. + + + +<ulink url="kdeapi:kdeui/KListView">KIconView</ulink> + +A variant of QIconView that honors KDE's system-wide settings. + + + +<ulink url="kdeapi:kdeui/KListView">KLineEdit</ulink> + +A variant of QLineEdit with completion support. + + + +<ulink url="kdeapi:kdeui/KComboBox">KComboBox</ulink> + +A variant of QComboBox with completion support. + + + +<ulink url="kdeapi:kdeui/KFontCombo">KFontCombo</ulink> + +A combo box for selecting fonts. + + + +<ulink url="kdeapi:kdeui/KColorCombo">KColorCombo</ulink> + +A combo box for selecting colors. + + + +<ulink url="kdeapi:kdeui/KColorButton">KColorButton</ulink> + +A button for selecting colors. + + + +<ulink url="kdeapi:kdeui/KURLCombo">KURLCombo</ulink> + +A combo box for selecting file names and URLs. + + + +<ulink url="kdeapi:kfile/KURLRequester">KURLRequester</ulink> + +A line edit for selecting file names and URLs. + + + +<ulink url="kdeapi:kdeui/KRuler">KRuler</ulink> + +A ruler widget. + + + +<ulink +url="kdeapi:kdeui/KAnimWidget">KAnimWidget</ulink> + +animations. + + + +<ulink url="kdeapi:kdeui/KNumInput">KNumInput</ulink> + +A widget for inputting numbers. + + + +<ulink url="kdeapi:kdeui/KPasswordEdit">KPasswordEdit</ulink> + +A widget for inputting passwords. + + + + + + +Dialogs - full-featured dialogs for file, color and font selection. + + + + +<ulink url="kdeapi:kfile/KFileDialog">KFileDialog</ulink> + +A file selection dialog. + + + +<ulink url="kdeapi:kdeui/KColorDialog">KColorDialog</ulink> + +A color selection dialog. + + + +<ulink url="kdeapi:kdeui/KFontDialog">KFontDialog</ulink> + +A font selection dialog. + + + +<ulink url="kdeapi:kfile/KIconDialog">KIconDialog</ulink> + +An icon selection dialog. + + + +<ulink url="kdeapi:kdeui/KKeyDialog">KKeyDialog</ulink> + +A dialog for editing keyboard bindings. + + + +<ulink url="kdeapi:kdeui/KEditToolBar">KEditToolBar</ulink> + +A dialog for editing toolbars. + + + +<ulink url="kdeapi:kdeui/KTipDialog">KTipDialog</ulink> + +A Tip-of-the-day dialog. + + + +<ulink url="kdeapi:kdeui/KAboutDialog">KAboutDialog</ulink> + +An about dialog. + + + +<ulink url="kdeapi:kdeui/KLineEditDlg">KLineEditDlg</ulink> + +A simple dialog for entering text. + + + +<ulink url="kdeapi:kfile/KURLRequesterDlg">KURLRequesterDlg</ulink> + +A simple dialog for entering URLs. + + + +<ulink url="kdeapi:kdeui/KMessageBox">KMessageBox</ulink> + +A dialog for signaling errors and warnings. + + + +<ulink url="kdeapi:kdeui/KPasswordDialog">KPasswordDialog</ulink> + +A dialog for inputting passwords. + + + + + + +Actions and XML GUI + + + + +<ulink url="kdeapi:kdeui/KAction">KAction</ulink> + +Abstraction for an action that can be plugged into menu bars and tool bars. + + + +<ulink url="kdeapi:kdeui/KActionCollection">KActionCollection</ulink> + +A set of actions. + + + +<ulink url="kdeapi:kdeui/KXMLGUIClient">KXMLGUIClient</ulink> + +A GUI fragment consisting of an action collection and a DOM tree representing their location in the GUI. + + + +<ulink url="kdeapi:kparts/KPartManager">KPartManager</ulink> + +Manages the activation of XMLGUI clients. + + + + + + +Plugins and Components + + + + +<ulink url="kdeapi:kdecore/KLibrary">KLibrary</ulink> + +Represents a dynamically loaded library. + + + +<ulink url="kdeapi:kdecore/KLibrary">KLibLoader</ulink> + +Shared library loading. + + + +<ulink url="kdeapi:kdecore/KLibFactory">KLibFactory</ulink> + +Object factory in plugins. + + + +<ulink url="kdeapi:kio/KServiceType">KServiceType</ulink> + +Represents a service type. + + + +<ulink url="kdeapi:kio/KService">KService</ulink> + +Represents a service. + + + +<ulink url="kdeapi:kio/KMimeType">KMimeType</ulink> + +Represents a MIME type. + + + +<ulink url="kdeapi:kio/KServiceTypeProfile">KServiceTypeProfile</ulink> + +User preferences for MIME type mappings. + + + +<ulink url="kdeapi:kio/KServiceTypeProfile">KTrader</ulink> + +Querying for services. + + + + + + + + + + + + +Graphics + + +Low-level graphics with QPainter + + +Rendering with QPainter + + +Qt's low level imaging model is based on the capabilities provided by X11 and +other windowing systems for which Qt ports exist. But it also extends these by +implementing additional features such as arbitrary affine transformations for +text and pixmaps. + + + +The central graphics class for 2D painting with Qt is +QPainter. It can +draw on a +QPaintDevice. +There are three possible paint devices implemented: One is +QWidget +which represents a widget on the screen. The second is +QPrinter which +represents a printer and produces Postscript output. The third it +the class +QPicture which +records paint commands and can save them on disk and play them back +later. A possible storage format for paint commands is the W3C standard +SVG. + + + +So, it is possible to reuse the rendering code you use for displaying a +widget for printing, with the same features supported. Of course, in +practice, the code is used in a slightly different context. Drawing +on a widget is almost exclusively done in the paintEvent() method +of a widget class. + + + +void FooWidget::paintEvent() +{ + QPainter p(this); + // Setup painter + // Use painter +} + + + +When drawing on a printer, you have to make sure to use QPrinter::newPage() +to finish with a page and begin a new one - something that naturally is not +relevant for painting widgets. Also, when printing, you may want to use the +device metrics +in order to compute coordinates. + + + + + + +Transformations + + +By default, when using QPainter, it draws in the natural coordinate +system of the device used. This means, if you draw a line along the horizontal +axis with a length of 10 units, it will be painted as a horizontal line +on the screen with a length of 10 pixels. However, QPainter can apply arbitrary +affine transformations before actually rendering shapes and curves. An +affine transformation maps the x and y coordinates linearly into x' and +y' according to + + + + + + + +The 3x3 matrix in this equation can be set with QPainter::setWorldMatrix() and +is of type QWMatrix. +Normally, this is the identity matrix, i.e. m11 and m22 are one, and the +other parameters are zero. There are basically three different groups of +transformations: + + + + + +Translations + +These move all points of an object by a fixed amount in +some direction. A translation matrix can be obtained by calling +method m.translate(dx, dy) for a QWMatrix. This corresponds to the +matrix + + + + + + + + + + +Scaling + +These stretch or shrink the coordinates of an object, making +it bigger or smaller without distorting it. A scaling transformation +can be applied to a QWMatrix by calling m.scale(sx, sy). This corresponds +to the matrix + + + + + + + + +By setting one of the parameters to a negative value, one can +achieve a mirroring of the coordinate system. + + + + + +Shearing + +A distortion of the coordinate system with two +parameters. A shearing transformation can be applied by calling +m.shear(sh, sv), corresponding to the matrix + + + + + + + + + + +Rotating + +This rotates an object. A rotation transformation can be +applied by calling m.rotate(alpha). Note that the angle has to be given +in degrees, not as mathematical angle! The corresponding matrix is + + + + + + + + +Note that a rotation is equivalent with a combination of +scaling and shearing. + + + + + + + +Here are some pictures that show the effect of the elementary +transformation to our masquot: + + + + + + + + + + + + + + + + + + + + +a) Normal +b) Rotated by 30 degrees +c) Sheared by 0.4 +d) Mirrored + + + + + + +Transformations can be combined by multiplying elementary matrices. Note that +matrix operations are not commutative in general, and therefore the combined +effect of of a concatenation depends on the order in which the matrices are +multiplied. + + + + + + +Setting stroking attributes + + +The rendering of lines, curves and outlines of polygons can be modified by +setting a special pen with QPainter::setPen(). The argument of this function is a +QPen object. The properties +stored in it are a style, a color, a join style and a cap style. + + + +The pen style is member of the enum +Qt::PenStyle. +and can take one of the following values: + + + + + + + +The join style is a member of the enum +Qt::PenJoinStyle. +It specifies how the junction between multiple lines which are attached to each +other is drawn. It takes one of the following values: + + + + + + + + + + + + + + + + + +a) MiterJoin +c) BevelJoin +b) RoundJoin + + + + + + +The cap style is a member of the enum +Qt::PenCapStyleand specifies how the end points of lines are drawn. It takes one of the values +from the following table: + + + + + + + + + + + + + + + + + +a) FlatCap +b) SquareCap +c) RoundCap + + + + + + + + + +Setting fill attributes + + +The fill style of polygons, circles or rectangles can be modified by setting +a special brush with QPainter::setBrush(). This function takes a +QBrush object as argument. +Brushes can be constructed in four different ways: + + + + +QBrush::QBrush() - This creates a brush that does not fill shapes. + + +QBrush::QBrush(BrushStyle) - This creates a black brush with one of the default +patterns shown below. + + +QBrush::QBrush(const QColor &, BrushStyle) - This creates a colored brush +with one of the patterns shown below. + + +QBrush::QBrush(const QColor &, const QPixmap) - This creates a colored +brush with the custom pattern you give as second parameter. + + + + +A default brush style is from the enum +Qt::BrushStyle. +Here is a picture of all predefined patterns: + + + + + + + +A further way to customize the brush behavior is to use the function +QPainter::setBrushOrigin(). + + + + + + +Color + + +Colors play a role both when stroking curves and when filling shapes. In Qt, +colors are represented by the class +QColor. Qt does not support +advanced graphics features like ICC color profiles and color correction. Colors +are usually constructed by specifying their red, green and blue components, as +the RGB model is the way pixels are composed of on a monitor. + + + +It is also possible to use hue, saturation and value. This HSV representation is +what you use in the Gtk color dialog, e.g. in GIMP. There, the hue corresponds +to the angle on the color wheel, while the saturation corresponds to the +distance from the center of the circle. The value can be chosen with a separate +slider. + + + + + + +Other settings + + +Normally, when you paint on a paint device, the pixels you draw replace those +that were there previously. This means, if you paint a certain region with +a red color and paint the same region with a blue color afterwards, only +the blue color will be visible. Qt's imaging model does not support +transparency, i.e. a way to blend the painted foreground with the background. +However, there is a simple way to combine background and foreground with +boolean operators. The method QPainter::setRasterOp() sets the used operator, +which comes from the enum +RasterOp. + + + +The default is CopyROP which ignores the background. Another popular choice is +XorROP. If you paint a black line with this operator on a colored image, then +the covered area will be inverted. This effect is for example used to create +the rubberband selections in image manipulation programs known as +"marching ants". + + + + + + +Drawing graphics primitives + + +In the following we list the elementary graphics elements supported by +QPainter. Most of them exist in several overloaded versions which take a +different number of arguments. For example, methods that deal with rectangles +usually either take a +QRect as argument or a set +of four integers. + + + + +Drawing a single point - drawPoint(). + + +Drawing lines - drawLine(), drawLineSegments() and drawPolyLine(). + + +Drawing and filling rectangles - drawRect(), drawRoundRect(), +fillRect() and eraseRect(). + + +Drawing and filling circles, ellipses and parts or them - +drawEllipse(), drawArc(), drawPie and drawChord(). + + +Drawing and filling general polygons - drawPolygon(). + + +Drawing bezier curves - drawQuadBezier() [drawCubicBezier in Qt 3.0]. + + + + + + + +Drawing pixmaps and images + + +Qt provides two very different classes to represent images. + + + +QPixmap directly corresponds +to the pixmap objects in X11. Pixmaps are server-side objects and may - on a +modern graphics card - even be stored directly in the card's memory. This makes +it very efficient to transfer pixmaps to the screen. Pixmaps also act as +an off-screen equivalent of widgets - the QPixmap class is a subclass of +QPaintDevice, so you can draw on it with a QPainter. Elementary drawing +operations are usually accelerated by modern graphics. Therefore, a common usage +pattern is to use pixmaps for double buffering. This means, instead of painting +directly on a widget, you paint on a temporary pixmap object and use the +bitBlt +function to transfer the pixmap to the widget. For complex repaints, this helps +to avoid flicker. + + + +In contrast, QImage objects +live on the client side. Their emphasis in on providing direct access to the +pixels of the image. This makes them of use for image manipulation, and things +like loading and saving to disk (QPixmap's load() method takes QImage as +intermediate step). On the other hand, painting an image on a widget is a +relatively expensive operation, as it implies a transfer to the X server, +which can take some time, especially for large images and for remote servers. +Depending on the color depth, the conversion from QImage to QPixmap may also +require dithering. + + + + + + +Drawing text + + +Text can be drawn with one of the overloaded variants of the method +QPainter::drawText(). These draw a QString either at a given point or in a given +rectangle, using the font set by QPainter::setFont(). There is also a parameter +which takes an ORed combination of some flags from the enums +Qt::AlignmentFlags +and +Qt::TextFlags + + + +Beginning with version 3.0, Qt takes care of the complete text layout even for +languages written from right to left. + + + +A more advanced way to display marked up text is the +QSimpleRichText +class. Objects of this class can be constructed with a piece of text using +a subset of the HTML tags, which is quite rich and provides even tables. +The text style can be customized by using a +QStyleSheet (the +documentation of the tags can also be found here). Once the rich text object has +been constructed, it can be rendered on a widget or another paint device with +the QSimpleRichText::draw() method. + + + + + + + + +Structured graphics with QCanvas + + +QPainter offers a powerful imaging model for painting on widgets and pixmaps. +However, it can also be cumbersome to use. Each time your widget receives +a paint event, it has to analyze the QPaintEvent::region() or +QPaintEvent::rect() which has to be redrawn. Then it has to setup a +QPainter and paint all objects which overlap with that region. For example, +image a vector graphics program which allows to drag objects like polygons, +circles and groups of them around. Each time those objects move a bit, the +widget's mouse event handler triggers a paint event for the whole area covered +by the objects in their old position and in their new position. Figuring +out the necessary redraws and doing them in an efficient way can be difficult, +and it may also conflict with the object-oriented structure of the program's +source code. + + + +As an alternative, Qt contains the class +QCanvas in which +you put graphical objects like polygons, text, pixmaps. You may also provide +additional items by subclassing +QCanvasItem or +one of its more specialized subclasses. A canvas can be shown on the screen by +one or more widgets of the class +QCanvasView which +you have to subclass in order to handle user interactions. Qt takes care of +all repaints of objects in the view, whether they are caused by the widget +being exposed, new objects being created or modified or other things. By using +double buffering, this can be done in an efficient and flicker-free way. + + + +Canvas items can overlap each other. In this case, the visible one depends on +the z order which can be assigned by QCanvasItem::setZ(). Items can also be +made visible or invisible. You can also provide a background to be drawn +"behind" all items and a foreground. For associating mouse events with objects, +in the canvas, there is the method QCanvas::collisions() which returns a list +of items overlapping with a given point. Here we show a screenshot of a canvas +view in action: + + + + + + + +Here, the mesh is drawn in the background. Furthermore, there is a +QCanvasText item and a violet QCanvasPolygon. The butterfly is a +QCanvasPixmap. It has transparent areas, so you can see the underlying +items through it. + + + +A tutorial on using QCanvas for writing sprite-based games can be +found here. + + + + + + +3D graphics with OpenGL + + +Low-level interface + + +The de facto standard for rendering 3D graphics today is +OpenGL. Implementations of this +specification come with Microsoft Windows, Mac OS X and XFree86 and often +support the hardware acceleration features offered by modern graphics cards. +OpenGL itself only deals with rendering on a specified area of the framebuffer +through a GL context and does not have any interactions +with the toolkit of the environment + + + +Qt offers the widget QGLWidget +which encapsulates a window with an associated GL context. Basically, you use it +by subclassing it and reimplementing some methods. + + + + + +Instead of reimplementing paintEvent() and using QPainter to draw the widget's +contents, you override paintGL() and use GL commands to render a scene. QLWidget +will take care of making its GL context the current one before paintGL() is +called, and it will flush afterwards. + + + +The virtual method initializeGL() is called once before the first time resizeGL() +or paintGL() are called. This can be used to construct display lists for objects, +and make any initializations. + + + +Instead of reimplementing resizeEvent(), you override resizeGL(). This can +be used to set the viewport appropriately. + + + +Instead of calling update() when the state of the scene has changed - for example +when you animate it with a timer -, you should call updateGL(). This will trigger +a repaint. + + + + + +In general, QGLWidget behaves just like any other widget, i.e. for example +you can process mouse events as usual, resize the widget and combine it with +others in a layout. + + + + + + + +Qt contains some examples of QGLWidget usage in its demo +example. A collection of tutorials can be found +here, +and more information and a reference of OpenGL is available on the +OpenGL homepage. + + + + + + +High-level interfaces + + +OpenGL is a relatively low-level interface for drawing 3D graphics. In the same +way QCanvas gives the programmer a higher-level interface which details with +objects and their properties, there are also high-level interfaces for 3D graphics. +One of the most popular is Open Inventor. Originally a technology developed by SGI, +there is today also the open source implementation +Coin, complemented by a toolkit binding to Qt +called SoQt. + + + +The basic concept of Open Inventor is that of a scene. +A scene can be loaded from disk and saved in a special format closely related +to VRML. A scene consists of a +collection of objects called nodes. Inventor already +provides a rich collection of reusable nodes, such as cubes, cylinders and +meshes, furthermore light sources, materials, cameras etc. Nodes are +represented by C++ classes and can be combined and subclassed. + + + +An introduction to Inventor can be found +here +(in general, you can substitute all mentions of SoXt by SoQt in this article). + + + + + + + + + + + +User interface + + +The action pattern + + + + + + + +Defining menus and toolbars in XML + + +Introduction + + +While the action pattern +allows to encapsulate actions triggered by the user in an object which can be +"plugged" somewhere in the menu bars or toolbars, it does not by itself solve +the problem of constructing the menus themselves. In particular, you have to +build all popup menus in C++ code and explicitly insert the actions in a +certain order, under consideration of the style guide for standard actions. +This makes it pretty difficult to allow the user to customize the menus or +change shortcuts to fit his needs, without changing the source code. + + + +This problem is solved by a set of classes called XMLGUI. +Basically, this separates actions (coded in C++) from their appearance in menu +bars and tool bars (coded in XML). Without modifying any source code, menus +can be simply customized by adjusting an XML file. Furthermore, it helps +to make sure that standard actions (such as +FileOpen +or HelpAbout) +appear in the locations suggested by the style guide. XMLGUI is especially +important for modular programs, where the items appearing in the menu bar may +come from many different plugins or parts. + + + +KDE's class for toplevel windows, +KMainWindow, +inherits +KXMLGUIClient +and therefore supports XMLGUI out of the box. All actions created within it must +have the client's actionCollection() as parent. A call to +createGUI() will then build the whole set of menu and tool +bars defined the applications XML file (conventionally with the suffix +ui.rc). + + + + + + +An example: Menu in KView + + +In the following, we take KDE's image view KView as +example. It has a ui.rc file named +kviewui.rc which is installed with the +Makefile.am snippet + + + +rcdir = $(kde_datadir)/kview +rc_DATA = kviewui.rc + + + +Here is an excerpt from the kviewui.rc file. For +simplicity, we show only the definition of the View menu. + + + +<!DOCTYPE kpartgui> +<kpartgui name="kview"> + <MenuBar> + <Menu name="view" > + <Action name="zoom50" /> + <Action name="zoom100" /> + <Action name="zoom200" /> + <Action name="zoomMaxpect" /> + <Separator/> + <Action name="fullscreen" /> + </Menu> + </MenuBar> +</kpartgui> + + + +The corresponding part of the setup in C++ is: + + + + KStdAction::zoomIn ( this, SLOT(slotZoomIn()), actionCollection() ); + KStdAction::zoomOut ( this, SLOT(slotZoomOut()), actionCollection() ); + KStdAction::zoom ( this, SLOT(slotZoom()), actionCollection() ); + new KAction ( i18n("&Half size"), ALT+Key_0, + this, SLOT(slotHalfSize()), + actionCollection(), "zoom50" ); + new KAction ( i18n("&Normal size"), ALT+Key_1, + this, SLOT(slotDoubleSize()), + actionCollection(), "zoom100" ); + new KAction ( i18n("&Double size"), ALT+Key_2, + this, SLOT(slotDoubleSize()), + actionCollection(), "zoom200" ); + new KAction ( i18n("&Fill Screen"), ALT+Key_3, + this, SLOT(slotFillScreen()), + actionCollection(), "zoomMaxpect" ); + new KAction ( i18n("Fullscreen &Mode"), CTRL+SHIFT+Key_F, + this, SLOT(slotFullScreen()), + actionCollection(), "fullscreen" ); + + + +The View menu resulting from this GUI definition looks like +in this screenshot: + + + + + + + +The XML file begins with a document type declaration. The DTD for kpartgui can +be found in the kdelibs sources in kdeui/kpartgui.dtd. The +outermost element of the file contains the instance name of the application as +attribute. It can also contain a version number in the form "version=2". This +is useful when you release new versions of an application with a changed menu +structure, e.g. with more features. If you bump up the version number of the +ui.rc file, KDE makes sure that any customized version of +the file is discarded and the new file is used instead. + + + +The next line, <MenuBar>, contains a declaration of a +menu bar. You can also insert any number of <ToolBar> +declarations in order to create some tool bars. The menu contains a submenu +with the name "view". This name is already predefined, and thus you see a +translated version of the word "View" in the screenshot. If you declare your +own submenus, you have to add the title explicitly. For example, +KView has a submenu with the title "Image" which is +declared as follows: + + + +<Menu name="image" > + <text>&amp;Image</text> + ... +</Menu> + + + +In KDE's automake framework, such titles are automatically extracted and put +into the application's .po +file , so it is considered by translators. Note that you have to write the +accelerator marker "&" in the form XML compliant form "&amp;". + + + +Let us come back to the example. KView's +View menu contains a couple of custom actions: +zoom50, zoom100, +zoom200, zoomMaxpect and +fullscreen, declared with a +<Action> element. The separator in the +screenshots corresponds to the <Separator> element. + + + +You will note that some menu items do not not have a corresponding element in +the XML file. These are standard actions. Standard +actions are created by the class +KStdAction. +When you create such actions in your application (such as in the C++ example +above), they will automatically be inserted in a prescribed position, and +possibly with an icon and a shortcut key. You can look up these locations in +the file kdeui/ui_standards.rc in the kdelibs sources. + + + + + + +An example: Toolbars in Konqueror + + +For the discussion of toolbars, we switch to +Konqueror's GUI definition. This excerpt defines +the location bar, which contains the input field for URLs. + + + +<ToolBar name="locationToolBar" fullWidth="true" newline="true" > + <text>Location Toolbar</text> + <Action name="clear_location" /> + <Action name="location_label" /> + <Action name="toolbar_url_combo" /> + <Action name="go_url" /> +</ToolBar> + + + +The first thing we notice is that there are a lot more attributes than for +menu bars. These include: + + + + + +fullWidth: Tells XMLGUI that the toolbar has the same width as the + toplevel window. Af this is "false", the toolbar only takes as much space as + necessary, and further toolbars are put in the same row. + + + +newline: This is related to the option above. If newline is "true", +the toolbar starts a new row. Otherwise it may be put in the row together +with the previous toolbar. + + + +noEdit: Normally toolbars can be customized by the user, +e.g. in SettingsConfigure +Toolbars in +Konqueror. Setting this option to "true" marks this +toolbar as not editable. This is important for toolbars which are filled with +items at runtime, e.g. Konqueror's bookmark toolbar. + + + +iconText: Tells XMLGUI to show the text of the action next to the +icon. Normally, the text is only shown as a tooltip when the mouse cursor +remains over the icon for a while. Possible values for this attribute are +"icononly" (shows only the icon), "textonly" (shows only the text), +"icontextright" (shows the text on the right side of the icon) and +"icontextbottom" (shows the text beneath the icon). + + + + +hidden: If this is "true", the toolbar is not visible initially +and must be activated by some menu item. + + + + +position: The default for this attribute is "top", meaning that the +toolbar is positioned under the menu bar. For programs with many tools, +such as graphics programs, it may be interesting to replace this with +"left", "right" or "bottom". + + + + + + + + +Dynamical menus + + +Obviously, an XML can only contain a static description of a user interface. +Often, there are menus which change at runtime. For example, +Konqueror's Location menu +contains a set of items Open with Foo with the +applications able to load a file with a given MIME type. Each time the +document shown changes, the list of menu items is updated. XMLGUI is prepared +to handle such cases with the notion of action lists. +An action list is declared as one item in the XML file, but consists of +several actions which are plugged into the menu at runtime. The above example +is implemented with the following declaration in +Konqueror's XML file: + + + +<Menu name="file"> + <text>&amp;Location</text> + ... + <ActionList name="openwith"> + ... +</Menu> + + + +The function KXMLGUIClient::plugActionList() is then used +to add actions to be displayed, whereas the function +KXMLGuiClient::unplugActionList() removes all +plugged actions. The routine responsible for updating looks as follows: + + + +void MainWindow::updateOpenWithActions() +{ + unplugActionList("openwith"); + openWithActions.clear(); + for ( /* iterate over the relevant services */ ) { + KAction *action = new KAction( ...); + openWithActions.append(action); + } + plugActionList("openwith", openWithActions); +} + + + +Note that in contrast to the static actions, the ones created here are +not constructed with the action collection as parent, and +you are responsible for deleting them for yourself. The simplest way to achievethis +is by using openWithActions.setAutoDelete(true) in the above +example. + + + + + + +Context menus + + +The examples above only contained cases where a main window's menubar and +toolbars were created. In the cases, the processes of constructing these +containers is completely hidden from you behind the +createGUI() call (except if you have custom containers). +However, there are cases, where you want to construct other containers and +populate them with GUI definitions from the XML file. One such example are +context menus. In order to get a pointer to a context menu, you have to +ask the client's factory for it: + + + +void MainWindow::popupRequested() +{ + QWidget *w = factory()->container("context_popup", this); + QPopupMenu *popup = static_cast<QPopupMenu *>(w); + popup->exec(QCursor::pos()); +} + + + +The method KXMLGUIFactory::container() used above looks +whether it finds a container in the XML file with the given name. Thus, a +possible definition could look as follows: + + + +... +<Menu name="context_popup"> + <Action name="file_add"/> + <Action name="file_remove"/> +</Menu> +... + + + + + + + + +Providing online help + + +Making a program easy and intuitive to use involves a wide range of +facilities which are usually called online help. Online help has several, +partially conflicting goals: on the one, it should give the user answers +to the question "How can I do a certain task?", on the other hand it +should help the user exploring the application and finding features he +doesn't yet know about. It is important to recognize that this can only +be achieved by offering several levels of help: + + + + + +Tooltips are tiny labels that pop up over user interface elements when +the mouse remains there longer. They are especially important for tool- +bars, where icons are not always sufficient to explain the purpose of +a button. + + + +"What's this?" help is usually a longer and richer explanation of a widget +or a menu item. It is also more clunky to use: In dialogs, it can be invoked +in two ways: either by pressing +ShiftF1 or by clicking +on the question mark in the title bar (where the support of the latter depends +on the window manager). The mouse pointer then turns into an arrow with a +question mark, and the help window appears when a user interfact element has +been clicked. "What's this?" help for menu items is usually activated by a +button in the toolbar which contains an arrow and a question mark. + + + +The problem with this approach is that the user can't see whether a widget +provides help or not. When the user activates the question mark button and +doesn't get any help window when clicking on a user interface element, he +will get frustrated very quickly. + + + +The advantage of "What's this?" help windows as provided by Qt and KDE is that +they can contain rich text, +i.e. the may contain different fonts, bold and italic text and even images and tables. + + + +An example of "What's this?" help: + + + + + + + + + +Finally, every program should have a manual. A manual is normally viewed in +KHelpCenter by activating the +Help menu. That means, a complete additional application +pops up and diverts the user from his work. Consequently, consulting the +manual should only be necessary if other facilities like tooltips and what's +this help are not sufficient. Of course, a manual has the advantage that it +does not explain single, isolated aspects of the user interface. Instead, it +can explain aspects of the application in a greater context. Manuals for KDE +are written using the DocBook markup +language. + + + + + +From the programmer's point of view, Qt provides an easy to use API for online +help. To assign a tooltip to widget, use the +QToolTip class. + + + +QToolTip::add(w, i18n("This widget does something.")) + + + +If the menu bars and tool bars are created using the +action pattern, the string used as tooltip is derived from the first argument +of the KAction constructor: + + + +action = new KAction(i18n("&Delete"), "editdelete", + SHIFT+Key_Delete, actionCollection(), "del") + + + +Here it is also possible to assign a text which is shown in the status bar when the +respective menu item is highlighted: + + + +action->setStatusText(i18n("Deletes the marked file")) + + + +The API for "What's this?' help is very similar. In dialogs, use the following +code: + + + +QWhatsThis::add(w, i18n("<qt>This demonstrates <b>Qt</b>'s" + " rich text engine.<ul>" + "<li>Foo</li>" + "<li>Bar</li>" + "</ul></qt>")) + + + +For menu items, use + + + +action->setWhatsThis(i18n("Deletes the marked file")) + + + +The invocation of KHelpCenter is encapsulated in the +KApplication +class. In order to show the manual of your application, just use + + + +kapp->invokeHelp() + + + +This displays the first page with the table of contents. When you want to +display only a certain section of the manual, you can give an additional +argument to invokeHelp() determining the anchor which +the browser jumps to. + + + + + + + + + +Components and services + + +KDE services + + +What are KDE services? + + +The notion of a service is a central concept in KDE's +modular architecture. There is no strict technical implementation connected +with this term - services can be plugins in the form of shared libraries, +or they can be programs controlled via DCOP. +By claiming to be of a certain service type, a service +promises to implement certain APIs or features. In C++ terms, one can think +of a service type as an abstract class, and a service as an implementation +of that interface. + + + +The advantage of this separation is clear: An application utilizing a service +type does not have to know about possible implementations of it. It just uses +the APIs associated with the service type. In this way, the used service can be +changed without affecting the application. Also, the user can configure which +services he prefers for certain features. + + + +Some examples: + + + + + +The HTML rendering engine used in Konqueror is an +embedable component that implements the service types +KParts/ReadOnlyPart and Browser/View. + + +In KDevelop HEAD, most functionality is packaged in +plugins with the service type KDevelop/Part. At startup, +all services with this type are loaded, such that you can extend the IDE in a +very flexible way. + + +In the icon view, Konqueror displays - if enabled - +thumbnail pictures of images, HTML pages, PDF and text files. This ability can +be extended. If you want it to display preview pictures of your own data files +with some MIME type, you can implement a service with service type +ThumbCreator. + + + + + +Obviously, a service is not only characterized by the service types it +implements, but also by some properties. For example, a +ThumbCreator does not only claim to implement the C++ class with the type +ThumbCreator, it also has a list of MIME types it is +responsible for. Similarly, KDevelop parts have the programming language they +support as a property. When an application requests a service type, it can +also list constraints on the properties of the service. In the above example, +when KDevelop loads the plugins for a Java project, it asks only for the +plugins which have Java as the programming language property. For this +purpose, KDE contains a full-blown CORBA-like trader with +a complex query language. + + + + + + +Defining service types + + +New service types are added by installing a description of them into the +directory KDEDIR/share/servicetypes. In an automake +framework, this can be done with this Makefile.am +snippet: + + + +kde_servicetypesdir_DATA = kdeveloppart.desktop +EXTRA_DIST = $(kde_servicetypesdir_DATA) + + + +The definition kdeveloppart.desktop of a +KDevelop part looks as follows: + + + +[Desktop Entry] +Type=ServiceType +X-KDE-ServiceType=KDevelop/Part +Name=KDevelop Part + +[PropertyDef::X-KDevelop-Scope] +Type=QString + +[PropertyDef::X-KDevelop-ProgrammingLanguages] +Type=QStringList + +[PropertyDef::X-KDevelop-Args] +Type=QString + + + +In addition to the usual entries, this example demonstrates how you declare +that a service has some properties. Each property definition corresponds +to a group [PropertyDef::name] in the configuration file. In +this group, the Type entry declares the type of the property. +Possible types are everything that can be stored in a +QVariant. + + + + + + +Defining shared library services + + +Service definitions are stored in the directory +KDEDIR/share/services: + + + +kde_servicesdir_DATA = kdevdoxygen.desktop +EXTRA_DIST = $(kde_servicesdir_DATA) + + + +The content of the following example file +kdevdoxygen.desktop defines the +KDevDoxygen plugin with the service type +KDevelop/Part: + + + +[Desktop Entry] +Type=Service +Comment=Doxygen +Name=KDevDoxygen +ServiceTypes=KDevelop/Part +X-KDE-Library=libkdevdoxygen +X-KDevelop-ProgrammingLanguages=C,C++,Java +X-KDevelop-Scope=Project + + + +In addition to the usual declarations, an important entry is +X-KDE-Library. This contains the name of the libtool +library (without the .la extension). It also fixes +(with the prefix init_ prepended) the name of the exported +symbol in the library which returns an object factory. For the above example, +the library must contain the following function: + + + +extern "C" { + void *init_libkdevdoxygen() + { + return new DoxygenFactory; + } +}; + + + +The type of the factory class DoxygenFactory depends on +the specific service type the service implements. In our example of a KDevelop +plugin, the factory must be a KDevFactory (which +inherits KLibFactory). More common examples are +KParts::Factory +which is supposed to produce +KParts::ReadOnlyPart +objects or in most cases the generic +KLibFactory. + + + + + + +Using shared library services + + +In order to use a shared library service in an application, you need to obtain a +KService object +representing it. This is discussed in the +section about MIME types (and in a section about the +trader to be written :-) + + + +With the KService object at hand, you can very simply +load the library and get a pointer to its factory object: + + + +KService *service = ... +QString libName = QFile::encodeName(service->library()); +KLibFactory *factory = KLibLoader::self()->factory(libName); +if (!factory) { + QString name = service->name(); + QString errorMessage = KLibLoader::self()->lastErrorMessage(); + KMessageBox::error(0, i18n("There was an error loading service %1.\n" + "The diagnostics from libtool is:\n%2") + .arg(name).arg(errorMessage); +} + + + +From this point, the further proceeding depends again on the service type. For +generic plugins, you create objects with the method +KLibFactory::create(). +For KParts, you must cast the factory pointer to the more specific KParts::Factory and use +its create() method: + + + +if (factory->inherits("KParts::Factory")) { + KParts::Factory *partFactory = static_cast<KParts::Factory*>(factory); + QObject *obj = partFactory->createPart(parentWidget, widgetName, + parent, name, "KParts::ReadOnlyPart"); + ... +} else { + cout << "Service does not implement the right factory" << endl; +} + + + + + + +Defining DCOP services + + +A DCOP service is usually implemented as a program that is started up when it is +needed. It then goes into a loop and listens for DCOP connections. The program +may be an interactive one, but it may also run completely or for a part of its +lifetime as a daemon in the background without the user noticing it. An example +for such a daemon is kio_uiserver, which implements user interaction +such as progress dialog for the KIO library. The advantage of such a centralized +daemon in this context is that e.g. the download progress for several different +files can be shown in one window, even if those downloads were initiated from +different applications. + + + +A DCOP service is defined differently from a shared library service. Of course, +it doesn't specify a library, but instead an executable. Also, DCOP services +do not specify a ServiceType line, because usually they are started by their +name. As additional properties, it contains two lines: + + + +X-DCOP-ServiceType specifies the way the service is +started. The value Unique says that the service must not be +started more than once. This means, if you try to start this service (e.g. via + +KApplication::startServiceByName(), KDE looks whether it is already +registered with DCOP and uses the running service. If it is not registered yet, +KDE will start it up and wait until is registered. Thus, you can immediately +send DCOP calls to the service. In such a case, the service should be implemented +as a +KUniqueApplication. + + + +The value Multi for X-DCOP-ServiceType says that multiple +instances of the service can coexist, so every attempt to start the service +will create another process. As a last possibility the value None +can be used. In this case, a start of the service will not wait until it +is registered with DCOP. + + + +X-KDE-StartupNotify should normally be set to false. Otherwise, when +the program is started, the task bar will show a startup notification, or, depending +on the user's settings, the cursor will be changed. + + + +Here is the definition of kio_uiserver: + + + +[Desktop Entry] +Type=Service +Name=kio_uiserver +Exec=kio_uiserver +X-DCOP-ServiceType=Unique +X-KDE-StartupNotify=false + + + + + + +Using DCOP services + + +A DCOP service is started with one of several methods in the KApplication +class: + + + +DCOPClient *client = kapp->dcopClient(); +client->attach(); +if (!client->isApplicationRegistered("kio_uiserver")) { + QString error; + if (KApplication::startServiceByName("kio_uiserver", QStringList(), &error)) + cout << "Starting kioserver failed with message " << error << endl; +} +... +QByteArray data, replyData; +QCString replyType; +QDataStream arg(data, IO_WriteOnly); +arg << true; +if (!client->call("kio_uiserver", "UIServer", "setListMode(bool)", + data, replyType, replyData)) + cout << "Call to kio_uiserver failed" << endl; +... + + + +Note that the example of a DCOP call given here uses explicit marshalling +of arguments. Often you will want to use a stub generated by dcopidl2cpp +instead, because it is much simpler and less error prone. + + + +In the example given here, the service was started "by name", i.e. the +first argument to KApplication::startServiceByName() is +the name is appearing in the Name line of the desktop +file. An alternative is to use +KApplication::startServiceByDesktopName(), which takes +the file name of its desktop file as argument, i.e. in this case +"kio_uiserver.desktop". + + + +All these calls take a list of URLs as a second argument, which is given +to the service on the command line. The third argument is a pointer to a +QString. If starting the service fails, this argument +is set to a translated error message. + + + + + + + + +MIME types + + +What are MIME types? + + +MIME types are used to describe the content type of files or data +chunks. Originally they were introduced in order to allow sending around image +or sound files etc. by e-mail (MIME stands for "Multipurpose Internet Mail +Extensions"). Later this system was also used by web browsers to determine how +to present data sent by a web server to the user. For example, an HTML page +has a MIME type "text/html", a postscript file "application/postscript". In +KDE, this concept is used at a variety of places: + + + + + +In Konqueror's icon view, files are represented by +icons. Each MIME type has a certain associated icon shown here. + + + +When you click onto a file icon or a file name in +Konqueror, either the file is shown in an embedded +view, or an application associated with the file type is opened. + + + +When you drag and drop some data from one application to another (or +within the same application), the drop target may choose to accept only +certain data types. Furthermore, it will handle image data different +from textual data. + + + +Clipboard data has a MIME type. Traditionally, X programs only handle +pixmaps or texts, but with Qt, there are no restrictions on the data type. + + + + + +From the above examples, it is clear that MIME handling is a complex issue. +First, it is necessary to establish a mapping from file names to MIME types. +KDE goes one step further in allowing even file contents to be mapped to +MIME types, for cases in which the file name is not available. Second, it +is necessary to map MIME types to applications or libraries which can view +or edit a file with a certain type, or create a thumbnail picture for it. + + + +There is a variety of APIs to figure out the MIME type of data or files. In +general, there is a certain speed/reliability trade-off you have to make. You +can find out the type of a file by examining only its file name (i.e. in most +cases the file name extension). For example, a file +foo.jpg is normally "image/jpeg". In cases where the +extension is stripped off this is not safe, and you actually have to look at +the contents of the file. This is of course slower, in particular for files +that have to be downloaded via HTTP first. The content-based method is based +on the file KDEDIR/share/mimelnk/magic and therefore +difficult to extend. But in general, MIME type information can easily be made +available to the system by installing a .desktop file, and +it is efficiently and conveniently available through the KDE libraries. + + + + + + +Defining MIME types + + +Let us define a type "application/x-foo" for our new +foobar program. To this end, you have to write a +file foo.desktop and install it into +KDEDIR/share/mimelnk/application. (This is the usual +location, which may differ between distributions). This can be done by adding +this to the Makefile.am: + + + +mimedir = $(kde_mimedir)/application +mime_DATA = foo.desktop +EXTRA_DIST = $(mime_DATA) + + + +The file foo.desktop should look as follows: + + + +[Desktop Entry] +Type=MimeType +MimeType=application/x-foo +Icon=fooicon +Patterns=*.foo; +DefaultApp=foobar +Comment=Foo Data File +Comment[de]=Foo Datei + + + +The "Comment" entry is supposed to be translated. Since the +.desktop file specifies an icon, you should also install +an icon fooicon.png, which represents the file e.g. in +Konqueror. + + + +In the KDE libraries, such a type definition is mapped to an instance of the +class KMimeType. +Use this like in the following example: + + + +KMimeType::Ptr type = KMimeType::mimeType("application/x-foo"); +cout << "Type: " << type->name() < endl; +cout << "Icon: " << type->icon() < endl; +cout << "Comment: " << type->icon() < endl; +QStringList patterns = type->patterns(); +QStringList::ConstIterator it; +for (it = patterns.begin(); it != patterns.end(); ++it) + cout << "Pattern: " << (*it) << endl; + + + + + + +Determining the MIME type of data + + +The fast method for determining the type of a file is +KMimeType::findByURL(). This looks for the URL string and +in most cases determines the type from the extension. For certain protocols +(e.g. http, man, info), this mechanism is not used. For example, CGI scripts +on web servers written in Perl often have the extension +.pl, which would indicate a +"text/x-perl" type. However, we file delivered by the +server is the output of this script, which is normally HTML. For such a case, +KMimeType::findByURL() returns the MIME type +"application/octet-stream" (available through +KMimeType::defaultMimeType()), which indicates a failure +to find out the type. + + + +KMimeType::Ptr type = KMimeType::findByURL("/home/bernd/foobar.jpg"); +if (type->name() == KMimeType::defaultMimeType()) + cout << "Could not find out type" << endl; +else + cout << "Type: " << type->name() << endl; + + + +(this method has some more arguments, but these are undocumented, so simply +forget about them.) + + + +You may want to find out a MIME from the contents of file instead of +the file name. This is more reliable, but also slower, as it requires +reading a part of the file. This is done with the +KMimeMagic +class, which has different error handling: + + + +KMimeMagicResult *result = KMimeMagic::self()->findFileType("/home/bernd/foobar.jpg"); +if (!result || !result->isValid()) + cout << "Could not find out type" << endl; +else + cout << "Type: " << result->mimeType() << endl; + + + +As a variant of this function, you can also determine the type of a memory +chunk. This is e.g. used in Kate in order to find +out the highlighting mode: + + + +QByteArray array; +... +KMimeMagicResult *result = KMimeMagic::self()->findBufferType(array); +if (!result || !result->isValid()) + cout << "Could not find out type" << endl; +else + cout << "Type: " << result->mimeType() << endl; + + + +Of course, even KMimeMagic is only able to determine a file type from the +contents of a local file. For remote files, there is a further possibility: + + + +KURL url("http://developer.kde.org/favicon.ico"); +QString type = KIO::NetAccess::mimetype(url); +if (type == KMimeType::defaultMimeType()) + cout << "Could not find out type" << endl; +else + cout << "Type: " << type << endl; + + + +This starts a KIO job to download a part of the file and check this. +Note that this function is perhaps quite slow and blocks the program. Normally +you will only want to use this if KMimeType::findByURL() +has returned "application/octet-stream". + + + +On the other hand, if you do not want to block your application, you can also +explicitly start the KIO job and connect to some of its signals: + + + +void FooClass::findType() +{ + KURL url("http://developer.kde.org/favicon.ico"); + KIO::MimetypeJob *job = KIO::mimetype(url); + connect( job, SIGNAL(result(KIO::Job*)), + this, SLOT(mimeResult(KIO::Job*)) ); +} + +void FooClass::mimeResult(KIO::Job *job) +{ + if (job->error()) + job->showErrorDialog(); + else + cout << "MIME type: " << ((KIO::MimetypeJob *)job)->mimetype() << endl; +} + + + + + + +Mapping a MIME type to an application or service + + +When an application is installed, it installs a .desktop +file which contains a list of MIME types this application can load. Similarly, +components like KParts make this information available by their service +.desktop files. So in general, there are several programs +and components which can process a given MIME type. You can obtain such a list +from the class KServiceTypeProfile: + + + +KService::OfferList offers = KServiceTypeProfile::offers("text/html", "Application"); +KService::OfferList::ConstIterator it; +for (it = offers.begin(); it != offers.end(); ++it) { + KService::Ptr service = (*it); + cout << "Name: " << service->name() << endl; +} + + + +The return value of this function is a list of service offers. A +KServiceOffer object packages a KService::Ptr together +with a preference number. The list returned by +KServiceTypeProfile::offers() is ordered by the user's +preference. The user can change this by calling "keditfiletype +text/html" or choosing Edit File Type on +Konqueror's context menu on a HTML file. + + + +In the above example, an offer list of the applications supporting +text/html was requested. This will - among others - contain +HTML editors like Quanta Plus. You can also replace +the second argument "Application" by +"KParts::ReadOnlyPart". In that case, you get a list of +embedable components for presenting HTML content, for example KHTML. + + + +In most cases, you are not interested in the list of all service offers +for a combination of MIME type and service type. There is a convenience +function which gives you only the service offer with the highest preference: + + + +KService::Ptr offer = KServiceTypeProfile::preferredService("text/html", "Application"); +if (offer) + cout << "Name: " << service->name() << endl; +else + cout << "No appropriate service found" << endl; + + + +For even more complex queries, there is a full-blown CORBA-like +trader. + + + +In order to run an application service with some URLs, use +KRun: + + + +KURL::List urlList; +urlList << "http://www.ietf.org/rfc/rfc1341.txt?number=1341"; +urlList << "http://www.ietf.org/rfc/rfc2046.txt?number=2046"; +KRun::run(offer.service(), urlList); + + + + + + +Miscellaneous + + +In this section, we want to list some APIs which are loosely related +to the previous discussion. + + + +Getting an icon for a URL. This looks for the type of the URL +and returns the associated icon. + + + +KURL url("ftp://ftp.kde.org/pub/incoming/wibble.c"); +QString icon = KMimeType::iconForURL(url); + + + +Running a URL. This looks for the type of the URL and starts the +user's preferred program associated with this type. + + + +KURL url("http://dot.kde.org"); +new KRun(url); + + + + + + + + +Network transparency + + +Introduction + + +In the age of the world wide web, it is of essential importance that desktop +applications can access resources over the internet: they should be able to +download files from a web server, write files to an ftp server or read mails +from a web server. Often, the ability to access files regardless of their +location is called network transparency. + + + +In the past, different approaches to this goals were implemented. The old NFS +file system is an attempt to implement network transparency on the level of +the POSIX API. While this approach works quite well in local, closely coupled +networks, it does not scale for resources to which access is unreliable and +possibly slow. Here, asynchronicity is important. While +you are waiting for your web browser to download a page, the user interface +should not block. Also, the page rendering should not begin when the page is +completely available, but should updated regularly as data comes in. + + + +In the KDE libraries, network transparency is implemented in the KIO API. The +central concept of this architecture is an IO job. A job +may copy, or delete files or similar things. Once a job is started, it works +in the background and does not block the application. Any communication from +the job back to the application - like delivering data or progress information +- is done integrated with the Qt event loop. + + + +Background operation is achieved by starting ioslaves to +perform certain tasks. ioslaves are started as separate processes and are +communicated with through UNIX domain sockets. In this way, no multi-threading +is necessary and unstable slaves can not crash the application that uses them. + + + +File locations are expressed by the widely used URLs. But in KDE, URLs do not +only expand the range of addressable files beyond the local file system. It +also goes in the opposite direction - e.g. you can browse into tar archives. +This is achieved by nesting URLs. For example, a file in a tar archive on +a http server could have the URL + + + +http://www-com.physik.hu-berlin.de/~bernd/article.tgz#tar:/paper.tex + + + + + + +Using KIO + + +In most cases, jobs are created by calling functions in the KIO namespace. +These functions take one or two URLs as arguments, and possible other +necessary parameters. When the job is finished, it emits the signal +result(KIO::Job*). After this signal has been emitted, the job +deletes itself. Thus, a typical use case will look like this: + + + +void FooClass::makeDirectory() +{ + SimpleJob *job = KIO::mkdir(KURL("file:/home/bernd/kiodir")); + connect( job, SIGNAL(result(KIO::Job*)), + this, SLOT(mkdirResult(KIO::Job*)) ); +} + +void FooClass::mkdirResult(KIO::Job *job) +{ + if (job->error()) + job->showErrorDialog(); + else + cout << "mkdir went fine" << endl; +} + + + +Depending on the type of the job, you may connect also to other +signals. + + + +Here is an overview over the possible functions: + + + + +KIO::mkdir(const KURL &url, int permission) + +Creates a directory, optionally with certain permissions. + + + +KIO::rmdir(const KURL &url) + +Removes a directory. + + + +KIO::chmod(const KURL &url, int permissions) + +Changes the permissions of a file. + + + +KIO::rename(const KURL &src, const KURL &dest, + bool overwrite) + +Renames a file. + + + +KIO::symlink(const QString &target, const KURL &dest, + bool overwrite, bool showProgressInfo) + +Creates a symbolic link. + + + +KIO::stat(const KURL &url, bool showProgressInfo) + +Finds out certain information about the file, such as size, modification +time and permissions. The information can be obtained from +KIO::StatJob::statResult() after the job has finished. + + + +KIO::get(const KURL &url, bool reload, bool showProgressInfo) + +Transfers data from a URL. + + + +KIO::put(const KURL &url, int permissions, bool overwrite, + bool resume, bool showProgressInfo) + +Transfers data to a URL. + + + +KIO::http_post(const KURL &url, const QByteArray &data, + bool showProgressInfo) +Posts data. Special for HTTP. + + + +KIO::mimetype(const KURL &url, bool showProgressInfo) + +Tries to find the MIME type of the URL. The type can be obtained from +KIO::MimetypeJob::mimetype() after the job has finished. + + + +KIO::file_copy(const KURL &src, const KURL &dest, int permissions, + bool overwrite, bool resume, bool showProgressInfo) + +Copies a single file. + + + +KIO::file_move(const KURL &src, const KURL &dest, int permissions, + bool overwrite, bool resume, bool showProgressInfo) + +Renames or moves a single file. + + + +KIO::file_delete(const KURL &url, bool showProgressInfo) + +Deletes a single file. + + + +KIO::listDir(const KURL &url, bool showProgressInfo) + +Lists the contents of a directory. Each time some new entries are known, the +signal KIO::ListJob::entries() is emitted. + + + +KIO::listRecursive(const KURL &url, bool showProgressInfo) + +Similar to the listDir() function, but this one is recursive. + + + +KIO::copy(const KURL &src, const KURL &dest, bool showProgressInfo) + +Copies a file or directory. Directories are copied recursively. + + + +KIO::move(const KURL &src, const KURL &dest, bool showProgressInfo) + +Moves or renames a file or directory. + + + +KIO::del(const KURL &src, bool shred, bool showProgressInfo) + +Deletes a file or directory. + + + + + + + + + +Directory entries + + +Both the KIO::stat() and KIO::listDir() jobs return their results as a type +UDSEntry, UDSEntryList resp. The latter is defined as QValueList<UDSEntry>. +The acronym UDS stands for "Universal directory service". The principle behind +it is that the a directory entry only carries the information which an ioslave +can provide, not more. For example, the http slave does not provide any +information about access permissions or file owners. +Instead, a UDSEntry is a list of UDSAtoms. Each atom provides a specific piece +of information. It consists of a type stored in m_uds and either an integer +value in m_long or a string value in m_str, depending on the type. + + + +The following types are currently defined: + + + + + +UDS_SIZE (integer) - Size of the file. + + + +UDS_USER (string) - User owning the file. + + + +UDS_GROUP (string) - Group owning the file. + + + +UDS_NAME (string) - File name. + + + +UDS_ACCESS (integer) - Permission rights of the file, as e.g. stored +by the libc function stat() in the st_mode field. + + + +UDS_FILE_TYPE (integer) - The file type, as e.g. stored by stat() in the +st_mode field. Therefore you can use the usual libc macros like S_ISDIR to +test this value. Note that the data provided by ioslaves corresponds to +stat(), not lstat(), i.e. in case of symbolic links, the file type here is +the type of the file pointed to by the link, not the link itself. + + + +UDS_LINK_DEST (string) - In case of a symbolic link, the name of the file +pointed to. + + + +UDS_MODIFICATION_TIME (integer) - The time (as in the type time_t) when the +file was last modified, as e.g. stored by stat() in the st_mtime field. + + + +UDS_ACCESS_TIME (integer) - The time when the file was last accessed, as +e.g. stored by stat() in the st_atime field. + + + +UDS_CREATION_TIME (integer) - The time when the file was created, as e.g. +stored by stat() in the st_ctime field. + + + +UDS_URL (string) - Provides a URL of a file, if it is not simply the +the concatenation of directory URL and file name. + + + +UDS_MIME_TYPE (string) - MIME type of the file + + + +UDS_GUESSED_MIME_TYPE (string) - MIME type of the file as guessed by the +slave. The difference to the previous type is that the one provided here +should not be taken as reliable (because determining it in a reliable way +would be too expensive). For example, the KRun class explicitly checks the +MIME type if it does not have reliable information. + + + + + +Although the way of storing information about files in a +UDSEntry is flexible and practical from the ioslave +point of view, it is a mess to use for the application programmer. For +example, in order to find out the MIME type of the file, you have to iterate +over all atoms and test whether m_uds is +UDS_MIME_TYPE. Fortunately, there is an API which is a lot +easier to use: the class KFileItem. + + + + + + +Synchronous usage + + +Often, the asynchronous API of KIO is too complex to use and therefore +implementing full asynchronicity is not a priority. For example, in a program +that can only handle one document file at a time, there is little that can be +done while the program is downloading a file anyway. For these simple cases, +there is a mucher simpler API in the form of a set of static functions in +KIO::NetAccess. For example, in order to copy a file, use + + + +KURL source, target; +source = ...; +target = ... +KIO::NetAccess::copy(source, target); + + + +The function will return after the complete copying process has finished. Still, +this method provides a progress dialog, and it makes sure that the application +processes repaint events. + + + +A particularly interesting combination of functions is +download() in combination with +removeTempFile(). The former downloads a file from given +URL and stores it in a temporary file with a unique name. The name is stored +in the second argument. If the URL is local, the file is +not downloaded, and instead the second argument is set to the local file +name. The function removeTempFile() deletes the file +given by its argument if the file is the result of a former download. If that +is not the case, it does nothing. Thus, a very easy to use way of loading +files regardless of their location is the following code snippet: + + + +KURL url; +url = ...; +QString tempFile; +if (KIO::NetAccess::download(url, tempFile) { + // load the file with the name tempFile + KIO::NetAccess::removeTempFile(tempFile); +} + + + + + + +Meta data + + +As can be seen above, the interface to IO jobs is quite abstract and does not +consider any exchange of information between application and IO slave that +is protocol specific. This is not always appropriate. For example, you may give +certain parameters to the HTTP slave to control its caching behavior or +send a bunch of cookies with the request. For this need, the concept of meta +data has been introduced. When a job is created, you can configure it by adding +meta data to it. Each item of meta data consists of a key/value pair. For +example, in order to prevent the HTTP slave from loading a web page from its +cache, you can use: + + + +void FooClass::reloadPage() +{ + KURL url("http://www.kdevelop.org/index.html"); + KIO::TransferJob *job = KIO::get(url, true, false); + job->addMetaData("cache", "reload"); + ... +} + + + +The same technique is used in the other direction, i.e. for communication from +the slave to the application. The method +Job::queryMetaData() asks for the value of the certain +key delivered by the slave. For the HTTP slave, one such example is the key +"modified", which contains a (stringified representation of) +the date when the web page was last modified. An example how you can use this +is the following: + + + +void FooClass::printModifiedDate() +{ + KURL url("http://developer.kde.org/documentation/kde2arch/index.html"); + KIO::TransferJob *job = KIO::get(url, true, false); + connect( job, SIGNAL(result(KIO::Job*)), + this, SLOT(transferResult(KIO::Job*)) ); +} + +void FooClass::transferResult(KIO::Job *job) +{ + QString mimetype; + if (job->error()) + job->showErrorDialog(); + else { + KIO::TransferJob *transferJob = (KIO::TransferJob*) job; + QString modified = transferJob->queryMetaData("modified"); + cout << "Last modified: " << modified << endl; +} + + + + + + +Scheduling + + +When using the KIO API, you usually do not have to cope with the details of +starting IO slaves and communicating with them. The normal use case is to +start a job and with some parameters and handle the signals the jobs emits. + + + +Behind the curtains, the scenario is a lot more complicated. When you create a +job, it is put in a queue. When the application goes back to the event loop, +KIO allocates slave processes for the jobs in the queue. For the first jobs +started, this is trivial: an IO slave for the appropriate protocol is started. +However, after the job (like a download from an http server) has finished, it +is not immediately killed. Instead, it is put in a pool of idle slaves and +killed after a certain time of inactivity (current 3 minutes). If a new request +for the same protocol and host arrives, the slave is reused. The obvious +advantage is that for a series of jobs for the same host, the cost for creating +new processes and possibly going through an authentication handshake is saved. + + + +Of course, reusing is only possible when the existing slave has already finished +its previous job. when a new request arrives while an existing slave process is +still running, a new process must be started and used. In the API usage in the +examples above, there are no limitation for creating new slave processes: if you +start a consecutive series of downloads for 20 different files, then KIO will +start 20 slave processes. This scheme of assigning slaves to jobs is called +direct. It not always the most appropriate scheme, as it +may need much memory and put a high load on both the client and server machines. + + + +So there is a different way. You can schedule jobs. If +you do this, only a limited number (currently 3) of slave processes for a +protocol will be created. If you create more jobs than that, they are put in a +queue and are processed when a slave process becomes idle. This is done as +follows: + + + +KURL url("http://developer.kde.org/documentation/kde2arch/index.html"); +KIO::TransferJob *job = KIO::get(url, true, false); +KIO::Scheduler::scheduleJob(job); + + + +A third possibility is connection oriented. For example, +for the IMAP slave, it does not make any sense to start multiple processes for +the same server. Only one IMAP connection at a time should be enforced. In +this case, the application must explicitly deal with the notion of a slave. It +has to deallocate a slave for a certain connection and then assign all jobs +which should go through the same connection to the same slave. This can again +be easily achieved by using the KIO::Scheduler: + + + +KURL baseUrl("imap://bernd@albert.physik.hu-berlin.de"); +KIO::Slave *slave = KIO::Scheduler::getConnectedSlave(baseUrl); + +KIO::TransferJob *job1 = KIO::get(KURL(baseUrl, "/INBOX;UID=79374")); +KIO::Scheduler::assignJobToSlave(slave, job1); + +KIO::TransferJob *job2 = KIO::get(KURL(baseUrl, "/INBOX;UID=86793")); +KIO::Scheduler::assignJobToSlave(slave, job2); + +... + +KIO::Scheduler::disconnectSlave(slave); + + + +You may only disconnect the slave after all jobs assigned to it are guaranteed +to be finished. + + + + + + +Defining an ioslave + + +In the following we discuss how you can add a new ioslave to the system. +In analogy to services, new ioslaves are advertised to the system by +installing a little configuration file. The following Makefile.am +snippet installs the ftp protocol: + + + +protocoldir = $(kde_servicesdir) +protocol_DATA = ftp.protocol +EXTRA_DIST = $(mime_DATA) + + + +The contents of the file ftp.protocol is as follows: + + + +[Protocol] +exec=kio_ftp +protocol=ftp +input=none +output=filesystem +listing=Name,Type,Size,Date,Access,Owner,Group,Link, +reading=true +writing=true +makedir=true +deleting=true +Icon=ftp + + + +The "protocol" entry defines for which protocol this slave +is responsible. "exec" is (in contrast what you would +expect naively) the name of the library that implements the slave. When the +slave is supposed to start, the "kdeinit" executable is +started which in turn loads this library into its address space. So in +practice, you can think of the running slave as a separate process although it +is implemented as library. The advantage of this mechanism is that it saves a +lot of memory and reduces the time needed by the runtime linker. + + + +The "input" and "output" lines are not used currently. + + + +The remaining lines in the .protocol file define which +abilities the slave has. In general, the features a slave must implement are +much simpler than the features the KIO API provides for the application. The +reason for this is that complex jobs are scheduled to a couple of subjobs. For +example, in order to list a directory recursively, one job will be started for +the toplevel directory. Then for each subdirectory reported back, new subjobs +are started. A scheduler in KIO makes sure that not too many jobs are active +at the same time. Similarly, in order to copy a file within a protocol that +does not support copying directly (like the ftp: protocol), +KIO can read the source file and then write the data to the destination +file. For this to work, the .protocol must advertise the +actions its slave supports. + + + +Since slaves are loaded as shared libraries, but constitute standalone programs, +their code framework looks a bit different from normal shared library plugins. +The function which is called to start the slave is called +kdemain(). This function does some initializations and +then goes into an event loop and waits for requests by the application using +it. This looks as follows: + + + +extern "C" { int kdemain(int argc, char **argv); } + +int kdemain(int argc, char **argv) +{ + KLocale::setMainCatalogue("kdelibs"); + KInstance instance("kio_ftp"); + (void) KGlobal::locale(); + + if (argc != 4) { + fprintf(stderr, "Usage: kio_ftp protocol " + "domain-socket1 domain-socket2\n"); + exit(-1); + } + + FtpSlave slave(argv[2], argv[3]); + slave.dispatchLoop(); + return 0; +} + + + + + + +Implementing an ioslave + + +Slaves are implemented as subclasses of KIO::SlaveBase +(FtpSlave in the above example). Thus, the actions listed in the +.protocol correspond to certain virtual functions in +KIO::SlaveBase the slave implementation must +reimplement. Here is a list of possible actions and the corresponding virtual +functions: + + + + +reading - Reads data from a URL +void get(const KURL &url) + +writing - Writes data to a URL and create the file if it does not exist yet. +void put(const KURL &url, int permissions, bool overwrite, bool resume) + +moving - Renames a file. +void rename(const KURL &src, const KURL &dest, bool overwrite) + +deleting - Deletes a file or directory. +void del(const KURL &url, bool isFile) + +listing - Lists the contents of a directory. +void listDir(const KURL &url) + +makedir - Creates a directory. +void mkdir(const KURL &url, int permissions) + + + + +Additionally, there are reimplementable functions not listed in the .protocol +file. For these operations, KIO automatically determines whether they are supported +or not (i.e. the default implementation returns an error). + + + + +Delivers information about a file, similar to the C function stat(). +void stat(const KURL &url) + +Changes the access permissions of a file. +void chmod(const KURL &url, int permissions) + +Determines the MIME type of a file. +void mimetype(const KURL &url) + +Copies a file. +copy(const KURL &url, const KURL &dest, int permissions, bool overwrite) + +Creates a symbolic link. +void symlink(const QString &target, const KURL &dest, bool overwrite) + + + + +All these implementation should end with one of two calls: If the operation +was successful, they should call finished(). If an error has occurred, +error() should be called with an error code as first argument and a +string in the second. Possible error codes are listed as enum +KIO::Error. The second argument is usually the URL in +question. It is used e.g. in KIO::Job::showErrorDialog() +in order to parameterize the human-readable error message. + + + +For slaves that correspond to network protocols, it might be interesting to +reimplement the method SlaveBase::setHost(). This is +called to tell the slave process about the host and port, and the user name +and password to log in. In general, meta data set by the application can be +queried by SlaveBase::metaData(). You can check for the +existence of meta data of a certain key with +SlaveBase::hasMetaData(). + + + + + + +Communicating back to the application + + +Various actions implemented in a slave need some way to communicate data back +to the application using the slave process: + + + + + +get() sends blocks of data. This is done with +data(), which takes a QByteArray +as argument. Of course, you do not need to send all data at once. If you send +a large file, call data() with smaller data blocks, so +the application can process them. Call finished() when +the transfer is finished. + + + +listDir() reports information about the entries of a +directory. For this purpose, call listEntries() with a +KIO::UDSEntryList as argument. Analogously to +data(), you can call this several times. When you are +finished, call listEntry() with the second argument set +to true. You may also call totalSize() to report the +total number of directory entries, if known. + + + +stat() reports information about a file like size, MIME +type, etc. Such information is packaged in a +KIO::UDSEntry, which will be discussed below. Use +statEntry() to send such an item to the application. + + + +mimetype() calls mimeType() with a +string argument. + + + +get() and copy() may want to provide +progress information. This is done with the methods +totalSize(), processedSize(), +speed(). The total size and processed size are reported +as bytes, the speed as bytes per second. + + + +You can send arbitrary key/value pairs of meta data with +setMetaData(). + + + + + + + + +Interacting with the user + + +Sometimes a slave has to interact with the user. Examples include informational +messages, authentication dialogs and confirmation dialogs when a file is about +to be overwritten. + + + + + +infoMessage() - This is for informational feedback, such +as the message "Retrieving data from <host>" from the http slave, which +is often displayed in the status bar of the program. On the application side, +this method corresponds to the signal +KIO::Job::infoMessage(). + + + +warning() - Displays a warning in a message box with +KMessageBox::information(). If a message box is still +open from a former call of warning() from the same slave process, nothing +happens. + + + +messageBox() - This is richer than the previous +method. It allows to open a message box with text and caption and some +buttons. See the enum SlaveBase::MessageBoxType for reference. + + + +openPassDlg() - Opens a dialog for the input of user name +and password. + + + + + + + + + + + + + +Licensing + +&underFDL; +&underGPL; + + + + diff --git a/doc/kdearch/joinbevel.png b/doc/kdearch/joinbevel.png new file mode 100644 index 00000000..584b6bd4 Binary files /dev/null and b/doc/kdearch/joinbevel.png differ diff --git a/doc/kdearch/joinmiter.png b/doc/kdearch/joinmiter.png new file mode 100644 index 00000000..e5d94b13 Binary files /dev/null and b/doc/kdearch/joinmiter.png differ diff --git a/doc/kdearch/joinround.png b/doc/kdearch/joinround.png new file mode 100644 index 00000000..9a8bbe93 Binary files /dev/null and b/doc/kdearch/joinround.png differ diff --git a/doc/kdearch/konqi-mirrored.png b/doc/kdearch/konqi-mirrored.png new file mode 100644 index 00000000..5145c0ee Binary files /dev/null and b/doc/kdearch/konqi-mirrored.png differ diff --git a/doc/kdearch/konqi-normal.png b/doc/kdearch/konqi-normal.png new file mode 100644 index 00000000..c16e1475 Binary files /dev/null and b/doc/kdearch/konqi-normal.png differ diff --git a/doc/kdearch/konqi-rotated.png b/doc/kdearch/konqi-rotated.png new file mode 100644 index 00000000..157e82dd Binary files /dev/null and b/doc/kdearch/konqi-rotated.png differ diff --git a/doc/kdearch/konqi-sheared.png b/doc/kdearch/konqi-sheared.png new file mode 100644 index 00000000..ee645f87 Binary files /dev/null and b/doc/kdearch/konqi-sheared.png differ diff --git a/doc/kdearch/kview-menu.png b/doc/kdearch/kview-menu.png new file mode 100644 index 00000000..0e57e721 Binary files /dev/null and b/doc/kdearch/kview-menu.png differ diff --git a/doc/kdearch/opengl.png b/doc/kdearch/opengl.png new file mode 100644 index 00000000..2489777d Binary files /dev/null and b/doc/kdearch/opengl.png differ diff --git a/doc/kdearch/penstyles.png b/doc/kdearch/penstyles.png new file mode 100644 index 00000000..7e976bcd Binary files /dev/null and b/doc/kdearch/penstyles.png differ diff --git a/doc/kdearch/whatsthis.png b/doc/kdearch/whatsthis.png new file mode 100644 index 00000000..4bdba093 Binary files /dev/null and b/doc/kdearch/whatsthis.png differ diff --git a/doc/kdevelop/Makefile.am b/doc/kdevelop/Makefile.am new file mode 100644 index 00000000..41691557 --- /dev/null +++ b/doc/kdevelop/Makefile.am @@ -0,0 +1,3 @@ +KDE_LANG = en +KDE_DOCS = AUTO + diff --git a/doc/kdevelop/SF-general.png b/doc/kdevelop/SF-general.png new file mode 100644 index 00000000..0824c835 Binary files /dev/null and b/doc/kdevelop/SF-general.png differ diff --git a/doc/kdevelop/SF-indent.png b/doc/kdevelop/SF-indent.png new file mode 100644 index 00000000..d84cd469 Binary files /dev/null and b/doc/kdevelop/SF-indent.png differ diff --git a/doc/kdevelop/SF-other.png b/doc/kdevelop/SF-other.png new file mode 100644 index 00000000..750f112b Binary files /dev/null and b/doc/kdevelop/SF-other.png differ diff --git a/doc/kdevelop/adv-build-management.docbook b/doc/kdevelop/adv-build-management.docbook new file mode 100644 index 00000000..e589a007 --- /dev/null +++ b/doc/kdevelop/adv-build-management.docbook @@ -0,0 +1,128 @@ + +Advanced Build Management +&automake; + + +Multiple Build Configurations +build configurationsmultiple + + +(... to be written ...) + + + + + + + +Cross-Compiling +cross compiling +compilingcross + + + +When you have suitable cross compilers available, you can cross compile your +programs for processors and operating systems different from the system where +&kdevelop; and the compiler is running. The &GNU; compiler collection &gcc; can +be configured and compiled as a cross compiler if you compile it yourself. +Consult the GCC info pages for +more information. Some &Linux; distributions also provide binary packages. + + + +An automake based package can easily be +cross-compiled by specifying the option to the +configure script and setting the CC and CXX +environment variables to the respective cross compiler binaries. Often you +want to switch between a the cross-compiled version of your application and +one compiled for your development system. For this, it is advantageous to +use &kdevelop; capability of creating multiple build configurations, as +explained in . Once you have created a +new build configuration for cross-compiling in the +ProjectProject +Options... dialog, add the option + + +platform + + +to the configure options. The platform name +is a tuple of the form + + +cpu-vendor-os +or +cpu-vendor-kernel-os + + +For many combinations, you can use a short form, for instance +i386-linux or arm-elf. + + + + + + + +Qt/Embedded +embeddedQt +Qt/Embedded +Qtopia +framebuffer + + +&qte; is a version of the &Qt; library that does not use the X window +system, but draws directly to the framebuffer on &Linux; systems. It is +therefore interesting for embedded systems which have tight restrictions +on the memory usage of the whole system. Its &API; is fully compatible with +the one of the X11 version. + + + +Developing an application for &qte; with &kdevelop; is not very different +from developing a program for the X11 version of &Qt;. In fact, you can use the +same codebase for both versions. If you use the autoproject project +management, you switch to the embedded version by passing the argument + to the configure script. You can set +this in the Project +Project Options... dialog under +Configure Options. With the option + you set the directory in which &qte; +is installed. + + + +After configuring and compiling your application with these options, it will +link with the libqpe.so library. This version of your +application will not normally run when you use X11. In order to test it, +run it under the control of the program qvfb +(&Qt; Virtual Frame Buffer). This is done by starting +qvfb and then starting your application with + + +app + + +Naturally, when you have a working version of your application, you +will want to use it on the target processor. For this, it will probably +be convenient to create multiple build configurations, as explained above, +so that you can quickly switch between the version running on your development +system and the version running on the target system. + + + +Applications for &qte; normally run as single applications on the +device they are designed for. Trolltech also supports Qtopia, which is a +collection of applications for PIM, web browsing and various other areas that +work together in a consistent manner. It is the standard environment for +instance on the Sharp Zaurus. You can write applications that integrate into +this environment by using the Qtopia SDK. This implies making your application +class a subclass of QPEApplication and linking to the +library libqpe.so. If you develop your application with +the autoproject project management, you have to add + to the configure options. + + + + + diff --git a/doc/kdevelop/app-changelog.docbook b/doc/kdevelop/app-changelog.docbook new file mode 100644 index 00000000..50e8f4ee --- /dev/null +++ b/doc/kdevelop/app-changelog.docbook @@ -0,0 +1,69 @@ + +Changes + +Changes to This Document + + + + 2003-01-03 Bernd Gehrmann, Caleb Tennis + + + initial manual layout + + + many chapter contents sketched + + + + + + + + 2004-08-01 Bernd Pol, Ian Wadham + + + manual slightly reorganized + + + some missing chapters written + + + + + + + 2005-05-02 Volker Paul — Many changes, including: + + + split into one file per chapter/appendix + + + added command reference sorted by menu (descriptions not yet complete) + + + AppWizard tutorial in getting-started.docbook + + + reorganized chapters, guided by Konqueror manual + + + moved installation, Unix development, In a Nutshell to the appendix + + + rewrote plugin appendix, incl. plugin list generator listplugins.sh + + + + Still far from complete, but a small step forward. + + + + 2006-05-20 Bernd Pol — Filling in some more to be written holes: + + + + + + + + diff --git a/doc/kdevelop/app-files.docbook b/doc/kdevelop/app-files.docbook new file mode 100644 index 00000000..210e1469 --- /dev/null +++ b/doc/kdevelop/app-files.docbook @@ -0,0 +1,425 @@ + + + + + + + + BerndPol + + + + +Configuration Files Used by &kdevelop; + + +&kdevelop; uses a series of configuration files which are distributed amongst several directories. There are two main groups of configuration files to distinguish: + + + + &kdevelop; Default Configuration — files set up when &kdevelop; was installed. + + + User Oriented Configuration — files which contain user modifications of the defaults as well as settings made by the &kdevelop; application itself and its plugins. + + + + +&kdevelop; Default Configuration + + +On installation, &kdevelop; writes some default information files for setup and configuration purposes into subdirectories of the $KDEDIR installation directory (usually something like /opt/kde, /usr/local/kde, or some other user-defined installation directory, see Installing &kdevelop;). + + + +Default &kdevelop; Configuration + + +There is only one &kdevelop; specific default configuration file in the $KDEDIR/share/config/ directory: + + + + kdeveloprc + + This file contains the basic settings &kdevelop; needs to start. It will be copied to the user's $KDEHOME/share/config directory when &kdevelop; does not find a kdeveloprc file there on startup. + + + + + + + +Application Specific Defaults + + +Most &kdevelop; features are provided by KParts. These are basically applications specially designed to run in the &kdevelop; framework (see the overview in the Plugin Tools appendix). Each KPart application has its own set of configuration files whose defaults will be stored in several subdirectories of the $KDEDIR/share/apps/ installation directory. + + + +There are quite a lot of default configuration subdirectories in $KDEDIR/share/apps/ whose names all start with a kdev sequence. Most of them are for &kdevelop; internal use only. They might be deliberately grouped for readability as: + + Stand-alone Applications + Task Specific Parts + Project Generation Parts + Language Specific Parts + + + + + + Stand-alone Applications + + kdevelop/ — contains files to configure the &kdevelop; &IDE;: + + licenses/ — contains various licenses texts. + pics/ — contains the picture files used for the &kdevelop;, &kdevelop; Assistant, and &kdevelop; Designer splash screens. + profiles/ — contains default plugin profile settings. (Currently there is only a tiny profile provided which defines a minimum set of active &kdevelop; plugins.) + eventsrc — holds a lot of Process successful localization strings. + kdevelopui.rc — provides the basic menu and tool bar entries &kdevelop; uses. + kdevhtml_partui.rc — provides a Print... entry in the File menu, a Copy entry in the Edit menu, and Back and Forward arrows in the Browser Toolbar in case a &HTML; file is browsed from the Documentation plugin. + + + kdevassistant/ — provides the menu and tool bars of the stand-alone &kdevelop; Assistant documentation browser. + kdevdesigner/ and kdevdesignerpart/ — provide menu bar and tool bars of the stand-alone &kdevelop; user interface designer. + + + + Task Specific Parts + + kdevabbrev/ — contains files used by the Abbreviation Expansion plugin: + + sources/ — contains keyword definition files used by the Expand Text command. + templates/ — contains template definition files used by the Expand Abbreviation command. + kdevabbrev.rc — provides the Expand Text and Expand Abbreviation entries in the Edit menu. + + + + kdevappwizard/ — contains files used by the &appwizard; part: + + importfiles/ — contains .kdevelop project files which control the initialization of a new project. + imports/ — contains templates to set up project specific .desktop files. + template-common/ — contains various files commonly included in the project source directories. + templates/ — contains configuration files which describe the information to be included in a given project source directory. + *.png — project preview images used by the &appwizard;. + *.tar.gz — tarballs containing the source files to be included in a new generated project directory. + + + kdevastyle/ — provides the Reformat Source entry in the Edit menu. + kdevautoproject/ — provides most of the entries in the Build menu and the Build Toolbar (&kdevelop;) toolbar. + + kdevclassview/ — contains files used by the Class View project plugin: + + pics/ — contains the icons used in the Classes classview tree. + kdevclassview.tc — provides the Class Inheritance Diagram entry in the Projects menu as well as the classes navigation combo box in the Browser Toolbar. + + + kdevcloser/ — provides the Windows menu close entries. + kdevctags/ — provides the CTags entry in the Tools menu for the CTags Frontend project plugin. + kdevcvsservice/ — provides the icon used by the CvsService tab and a short shell script used to add a new entry to the &cvs; repository, both used by the CVS Integration project plugin. + kdevdebugger/ — provides the Debug menu entries for the Debugger Frontend project plugin. + kdevdiff/ — provides the Difference Viewer entry in the Tools menu. + kdevdistpart/ — provides the Distribution & Publishing entry in the Project menu for the Final Packaging Support project plugin. + + kdevdocumentation/ — contains files used by the Documentation plugin: + + en/ and pics/ — contain files used by the htdig search tool. + tocs/ — contain the default &kdevelop; documentation content description files (see the description in Basic Structure of &kdevelop; TOC Files). + kdevpart_documentation.rc — provides the search related entries in the Help menu. + + + kdevdoxygen/ — provides the menu entries for the Doxygen Support project plugin. + + kdevfilecreate/ — contains files used by the New File Wizard: + + file-templates/ — provides the initial text contents to be put into the new source file of a given type. + kdevpart_filecreate.rc — provides the New entry in the File menu. + template-info.xml — contains descriptions of the available file types to be displayed in the New File tool view. + + + kdevfilter/ — provides the Execute Command... and Filter Selection Through Command... entries in the Tools menu used by the Shell Filtering and Insertion plugin. + kdevfullscreen/ — provides the Full Screen Mode entry in the View menu and the according tool bar icon. + kdevgrepview/ — provides the Find in Files...entry in the Edit menu used by the Grep Frontend plugin. + kdevhistory/ — provides the Back and Forward entries in the View menu. + kdevjavadebugger/ — provides a Java Debug menu in order to debug a &Java; application. + kdevoutputviews/ — provides the Next Error and Previous Error entries in the View menu. + kdevpartexplorer/ — provides the Part Explorer entry in the Tools menu used by the Part Explorer Tool plugin. + kdevquickopen/ — provides the Quick Open File.. entry in the File menu and the Quick Open Class... and Quick Open Method entries in the Tools menu used by the Quick Open project plugin. + kdevregexptest/ — provides the Debug Regular Expression... entry in the Tools menu used by the Regular Expression Tester plugin. + kdevreplace/ — provides the Find-Select-Replace... entry in the Edit menu used by the Replace Part plugin. + kdevtipofday/ — provides the Tip of the Day entry in the Help menu as well as a HTML-File containing the available tips. + kdevtools/ — controls various menu entries ceated by Tools Menu and External Tools Menu settings provided by the Tools Menu Addition plugin. + kdevvalgrind/ — provides the Valgrind Memory Leak Check and Profile with KCachegrind entries in the Debug menu used by the Valgrind Frontend plugin. + + + + Project Generation Parts + kdevadaproject/ — provides entries for the Build menu and according tool bar icons to build an Ada application. + kdevantproject/ — provides entries for the Build menu when the Ant project generator is used. + kdevautoproject/ — provides entries for the Build menu and according tool bar icons when working with the &GNU; Tools based &automake; project generator. Additionally provides the Add Translation and Build Configuration entries to the Project menu. + kdevcustomproject/ — provides entries for the Build menu and according tool bar icons when the project is based on custom Makefils. + kdevgenericproject/ — contains menu definitions for an experimental generic project generator. Currently (version 3.1.0) unused. + kdevhaskellproject/ — provides entries for the Build menu and according tool bar icons to build a Haskell application. + kdevpascalproject/ — provides entries for the Build menu and according tool bar icons to build a Pascal application. + kdevtrollproject/ — provides entries for the Build menu and according tool bar icons to build an application using the &Qt; QMake project manager. + + + + Language Specific Parts + kdevadasupport/ — provides entries in the Tools menu and according tool bar icons needed to develop Ada applications. + kdevbashsupport/ — provides entries in the Build menu and according tool bar icons needed to develop Bash scripts. + + kdevcppsupport/ — contains files used by the &appwizard; to build C++ applications: + + newclass/ — contains header and source templates from which the &appwizard; builds the according source files. + subclassing/ — contains templates which the &appwizard; uses to set up initial class declarations/definitions in the source files. + templates — contains templates from which the &appwizard; sets up the default header and source template files to be used by the &nfwizard;. + configuration — dummy template to add macros. + kdevcppsupport.rc — provides the Complete Text and Make Member entries fo the Edit menu, the Switch Header/Implementation entry for the View menu, and the New Class entry for the Project menu as well as a New Class icon for the Browser Toolbar. + + + kdevfortransupport/ — provides entries in the Build menu needed to develop Fortran applications. + kdevhaskellsupport/ — provides entries in the Build menu and according tool bar icons needed to develop Haskell applications. + kdevjavasupport/ — contains the UI definition needed to develop &Java; applications. + kdevpascalsupport/ — contains the UI definition needed to develop Pascal applications. + kdevperlsupport/ — provides Project and Help menu entries needed to develop Perl scripts. + kdevphpsupport/ — contains UI and PHP function definition files needed to develop PHP scripts. + kdevpythonsupport/ — provides Build and Help menu entries and according tool bar icons needed to develop Python scripts. + kdevrubysupport/ — provides Build menu entries and according tool bar icons needed to develop Ruby scripts. + kdevscriptproject/ — provides th UI definitions needed to develop custom projects. Currently (version 3.1.0) unused. + kdevsqlsupport/ — provides th UI definitions needed to develop SQL projects. Currently (version 3.1.0) unused. + + + + + + + + + + + +User Oriented Configuration + + +All information about user defined settings is kept in two subdirectories of $KDEHOME, namely: + + Application Specific Configuration in the $KDEHOME/share/apps/ directory, and + Resource Configuration File in the $KDEHOME/share/config/ directory. + + + + +Application Specific Configuration + + +Any user changes to the &kdevelop; Default Configuration settings as well as user specific settings which are not kept in any of the Resource Configuration Files are found in kdev... subdirectories of the $KDEHOME/share/apps/ directory. + + +Most of these configuration files are however used by various &kdevelop; plugins in order to provide some specific menu and/or toolbar entries. Thus they are of interest only in case something went really wrong with the user interface. + + +In case the contents of these directories mirror those of the Default Configuration settings, &kdevelop; will have copied them from $KDEDIR/apps/ into the $KDEHOME/apps/ directory on its initial start. Any subsequent changes will be made to these copies only. The Default Configuration settings remain unchanged in any case. + + + + + kdevabbrev/ — contains files used by the Abbreviation Expansion plugin: + + sources/ — currently empty; &kdevelop; uses the default keyword definition files for Expand Text commands. + templates/ — contains the user modified template definition files used by the Expand Abbreviation command. + kdevabbrev.rc — provides the Expand Text and Expand Abbreviation entries in the Edit menu. + + + + kdevappwizard/ — only provides the New Project... and Import Existing Project... entries in the Projects menu. The &appwizard; will use the default configuration settings for its actual works. + + + kdevastyle/ — provides the actual Reformat Source entry in the Edit menu. + + + kdevautoproject/ — provides the actual entries in the Build menu and the Build Toolbar (KDevelop) toolbar. + + + kdevclassview/ — provides the Class Inheritance Diagram entry in the Project menu and the class browser combo box in the Browser Toolbar by the Class View project plugin. + + + kdevcloser/ — provides the Close Selected Windows... entry in the Windows menu. + + + kdevcppsupport/ — holds the acual configuration used by the &appwizard; to build C++ applications. The &appwizard; however uses its main bulk of configuration information directly from the default configuration directory. See there for more detail. + + + newclass/ — contains the actual header and source templates from which the &appwizard; builds the according source files. + + + pcs/ — contains database files &kdevelop; uses build the actual Persistent Code Store (.pcs) file of a &kde; C++ project. + + + kdevcppsupport.rc — provides the Complete Text and Make Member entries fo the Edit menu, the Switch Header/Implementation entry for the View menu, and the New Class entry for the Project menu as well as a New Class icon for the Browser Toolbar. + + + + + kdevctags/ — provides the CTags entry in the Tools menu for the CTags Frontend project plugin. + + + kdevdebugger/ — provides the Debug menu entries for the Debugger Frontend project plugin. + + + kdevdiff/ — provides the Difference Viewer entry in the Tools menu. + + + kdevdocumentation/ — contains the actual files used by the Documentation plugin in addition to the default configuration files. See there for more detail. + The directories in kdevdocumentation/ mainly hold actual bookkeeping information. The actually set up documentation files are kept in doc...pluginrc files in the $KDEHOME/share/config/ directory. + + + bookmarks/ — maintains the entries in the Bookmarks tab of the &kdevelop; Documentation plugin. + + + index/ — holds various cache files &kdevelop; uses to speed up indexed documentation searches in the Index tab of the Documentation plugin. + + + search/ — contains files used by the htdig search tool which serves search calls from the Search tab of the Documentation plugin. + + + kdevpart_documentation.rc — provides the search related entries in the Help menu. + + + + + kdevdoxygen/ — provides the menu entries for the Doxygen Support project plugin. + + + kdevelop/ — contains some actual settings &kdevelop; uses for its basic setup: + + profiles/ — provides actual plugin profile setting. (Initially there is only a FullIDE profile which defines a full set of initially active &kdevelop; plugins.) + kdevelopui.rc — provides the basic menu and tool bar entries &kdevelop; uses. + + + + kdevfilecreate/ — contains files used by the New File Wizard: + + file-templates/ — provides the actually used text contents to be put into the new source file of a given type. More file templates are found in the default configuration files directory. + kdevpart_filecreate.rc — provides the New entry in the File menu. + template-info.xml — contains descriptions of the available file types to be displayed in the New File tool view. + + + + kdevfilter/ — provides the Execute Command... and Filter Selection Through Command... entries in the Tools menu used by the Shell Filtering and Insertion plugin. + + + kdevfullscreen/ — provides the Full Screen Mode entry in the View menu and the according tool bar icon. + + + kdevgrepview/ — provides the Find in Files...entry in the Edit menu used by the Grep Frontend plugin. + + + kdevoutputviews/ — provides the Next Error and Previous Error entries in the View menu. + + + kdevpartexplorer/ — provides the Part Explorer entry in the Tools menu used by the Part Explorer Tool plugin. + + + kdevquickopen/ — provides the Quick Open File.. entry in the File menu and the Quick Open Class... and Quick Open Method entries in the Tools menu used by the Quick Open project plugin. + + + kdevregexptest/ — provides the Debug Regular Expression... entry in the Tools menu used by the Regular Expression Tester plugin. + + + kdevreplace/ — provides the Find-Select-Replace... entry in the Edit menu used by the Replace Part plugin. + + + kdevtipofday/ —provides the Tip of the Day entry in the Help menu. The HTML-File containing the available tips is provided as a default configuration file only. + + + kdevtools/ — controls various menu entries ceated by Tools Menu and External Tools Menu settings provided by the Tools Menu Addition plugin. + + + kdevvalgrind/ — provides the Valgrind Memory Leak Check and Profile with KCachegrind entries in the Debug menu used by the Valgrind Frontend plugin. + + + + + + +Resource Configuration Files + + +There are two groups of &kdevelop; configuration files in the $KDEHOME/share/config/ directory, distiguished by their surrounding character sequences: + + doc...pluginrc denotes files used by the documentation plugin. + kdev...rc denotes configuration files used by &kdevelop; itself and its available plugins. + + + + +Configuration Files Used by &kdevelop; + + kdevabbrevrc — holds the current state of the Abbreviations configuration provided by the Abbreviation Expansion plugin. + This only records whether the abbreviations will be used or not. The actual definitions of new abbreviations will go into the $KDEHOME/share/apps/kdevabbrev/templates/templates file. + + + kdevassistantrc — holds some configuration states specific of the stand-alone &kdevelop; Assistant documentation browser. + Most common configuration settings are shared with the &kdevelop; IDE kdeveloprc file. + + kdevassistantuimode4rc — holds the current MDI configuration states (dock positions &etc;) of the stand-alone &kdevelop; Assistant documentation browser. + + kdevclassviewrc — holds the View Mode setting of the Classes class browser tab provided by the Class View project plugin. + This is a global setting, although the Class View plugin may be disabled on a per project basis. Any change in this setting will be globally updated whenever the current project is closed and thus affect all subsequently loaded projects. + + kdevcppsupportrc — holds some settings used to set up CPP source files. In particular you will find the settings made on the C++ Class Generator configuration dialog in here. + kdevdocumentationrc — holds actual settings the Documentation plugin uses. + kdeveloprc — holds the global settings the &kdevelop; IDE and the &kdevelop; Assistant stand-alone documentation browser will use. + kdevelopuimode4rc — holds the current MDI configuration states (dock positions &etc;) of the &kdevelop; IDE. + kdevfileselectorrc — holds actual settings the File Selector plugin uses. + kdevfileviewrc — holds the actual filename color settings the CVS Integration (Cervisia) project plugin uses for display. + kdevfilterrc — holds actual settings the Shell Filtering and Insertion plugin uses. + kdevgrepviewrc — holds actual settings the Grep Frontend plugin uses. + kdevsnippetrc — holds actual settings the Code Snippets plugin uses. + kdevtoolsrc — holds actual settings the Tools Menu Addition plugin uses. + + + +Configuration Files Used by the Documentation Plugin + docchmpluginrc — holds information about the actual &Microsoft; CHM help files as defined on the CHM Documentation Collection configuration page. + doccustompluginrc — holds information about any custom documentation file defined on the Custom Documentation Collection configuration page. + docdevhelppluginrc — holds information about the actual GNOME 2 DevHelp documentation files as defined on the Devhelp Documentation Collection configuration page. + docdoxygenpluginrc — holds information about the actual Doxygen generated API documentations as defined on the Doxygen Documentation Collection configuration page. + dockdevtocpluginrc — holds information about the actual KDevelopTOC structured documentation files as defined on the KDevelopTOC Documentation Collection configuration page. + docqtpluginrc — holds information about the QT documentation files actually included on the Documentation CollectionQt configuration page. + + + + + + + + + +Project Dependent Configuration + + +Most project dependend configuration is kept in the <project-name>.kdevelop and <project-name>.kdevses &kdevelop; project configuration files rather than in separate files as the other, more global, configuration settings. In short, those files are meant for: + + + <project-name>.kdevelop — global project configuration information. + <project-name>.kdevses — configuration information needed to restore the specific behaviours of the running session. + + +Both are &XML; coded files. They can be viewed and (cautiously) altered using any text editor. + + + +Persistent Code Store Files + +There is a third project dependend configuration file, the <project-name>.kdevelop.pcs Persistant Code Store. This is a binary coded file holding an internal parser cache for the most part in order to speed up the loading sequence of the project. Additionally, this Persistant Code Store keeps information use by the Code Completion facility of &kdevelop;. + + + +There can be additional Persistant Code Store files be set up on the Code Completion tab of the C++ Specific project configuration page. Information about these additional .pcs is kept globally in the $KDEHOME/share/apps/kdevcppsupport/pcs/ directory. + + + + + + diff --git a/doc/kdevelop/app-menu.docbook b/doc/kdevelop/app-menu.docbook new file mode 100644 index 00000000..954b65f2 --- /dev/null +++ b/doc/kdevelop/app-menu.docbook @@ -0,0 +1,61 @@ + + + + + BerndPol + + + + +Menus and Toolbars Overview + + +(... to be written ...) + + + +Menus + + +(... to be written ...) + + + +Commonly Available Menus + + +(... to be written ...) + + + + + +Project Specific Menus + + +(... to be written ...) + + + + + +Plugin Tools Specific Menus + + +(... to be written ...) + + + + + + + +Toolbars + + +(... to be written ...) + + + + + diff --git a/doc/kdevelop/app-misc-info.docbook b/doc/kdevelop/app-misc-info.docbook new file mode 100644 index 00000000..308be579 --- /dev/null +++ b/doc/kdevelop/app-misc-info.docbook @@ -0,0 +1,24 @@ + +Further Information + +Getting Information + +(... to be written ...) + + + + +Reporting Bugs + +(... to be written ...) + + + + +Licensing +&underFDL; +&underGPL; + + + + diff --git a/doc/kdevelop/app-uimodes-examples.docbook b/doc/kdevelop/app-uimodes-examples.docbook new file mode 100644 index 00000000..24b93c61 --- /dev/null +++ b/doc/kdevelop/app-uimodes-examples.docbook @@ -0,0 +1,125 @@ + +&kdevelop; User Interface Mode Examples + + +IDEAl Mode + + +Click here to return to the modes overview. + + + + + + + + Screenshot + &kdevelop; IDEAl mode + + + + +Click here to return to the modes overview. + + + + + + + + Screenshot + &kdevelop; IDEAl mode, closed tabs + + + + +This example screenshot demonstrates one of the main virtues of IDEAl mode. There is a maximum workspace available. Yet any tool view is readily available by clicking on the according tab. + + +You will most probably need some time to get accustomed to the icons in the tab bar. If you got lost, just position the mouse over a tab and wait a few seconds. A short tool tip description will pop up. In this screenshot the Automake Manager tool tip is shown as an example. It describes the lower tab in the right tab bar. + + + +Click here to return to the modes overview. + + + + + + + +Child Frame Windows Mode + + +Click here to return to the modes overview. + + + + + + + + Screenshot + &kdevelop; child frame windows mode + + + + +Click here to return to the modes overview. + + + + + + + +Tabbed Pages Mode + + +Click here to return to the modes overview. + + + + + + + + Screenshot + &kdevelop; tabbed pages mode + + + + +Click here to return to the modes overview. + + + + + + + +Toplevel Windows Mode + + +Click here to return to the modes overview. + + + + + + + + Screenshot + &kdevelop; toplevel windows mode + + + + +Click here to return to the modes overview. + + + + + + + diff --git a/doc/kdevelop/applicationwizard.docbook b/doc/kdevelop/applicationwizard.docbook new file mode 100644 index 00000000..ee732a78 --- /dev/null +++ b/doc/kdevelop/applicationwizard.docbook @@ -0,0 +1,820 @@ + + + + + BerndPol + + + + +Getting Started — the &appwizard; + + + + + + &appwizard; + + +In &kdevelop; software development work is organized in projects. Such a project keeps everything together which belongs to a complete programming task: source files, additional data files, any actually needed management facilities as the make system as well as access to all components and any additional tools needed to get the application up and running. + + +Organizing all development work in projects allows you to easily switch between the global tasks at hand. This is quite handy if you ⪚ work on several applications at the same time as is often the case. Tell &kdevelop; to open the project you want to work at and you may proceed in the environment just where you left. + + + +New Projects + + + + + + project + new + + +Whenever you want to initiate a new programming project quite a lot of formal setup procedures need to be done. An initial directory structure has to be set up, initial header and source files must be provided, the make system has to be initialized, &etc; + + +&kdevelop; provides an easy way to initiate a new programming project—the &appwizard;. You will find the &appwizard; at menu entry Project New Project. + + +Only a short series of steps is necessary to start a new programming project, using the &appwizard;: + + + + Select the programming language you want to use and the type of the application you want to build from a set of predefined templates. + + + Supply some general information as application name, directory where the application shall be built, &etc; + + + Decide whether you want to use a version control system, like ⪚ CVS, and supply the necessary data if needed. + + + Set up some templates for initial header and source files (if applicable). + + + Finally tell &appwizard; to set up all initial stuff, directory structure, starting header/source file templates, and management tools, like ⪚ an initial make skeleton, &etc; + + + +Voilà—that's all. &appwizard; will have provided you with a primary functional set of programming files, where you can readily start working. + + +Let's look at all this in more detail now ... + + + +Initial Steps + + + dialog + create new project + + project + create new project + dialog + + project + templates + + templates + project + + +To create a new project in &kdevelop;, select New Project from the Project menu. The Create New Project dialog will pop up showing an initial General page: + + + + + + + + + Initial dialog to set up a new project + + + + + +As you see, this dialog is divided into an upper and a lower part. In the upper part you can decide on the programming language and application type, the lower part holds some general information. + + + +Select Programming Language and Application Type + + + project + application type + + project + programming language + + project + language + + language + + programming language + + application + type + + +The left hand side of the upper part in this dialog is where you do the selection work. When it shows up, you'll find there a list of folders each labeled with a programming language, as there are: + + + + + Ada + + Ada + new project + + + C + + C + new project + + + C++ + + C++ + new project + + + Database (SQL Projects) + + SQL + new project + + Database + new project + + + Fortran + + Fortran + new project + + + Haskell + + Haskell + new project + + + Java + + Java + new project + + + PHP + + PHP + new project + + + Pascal + + Pascal + new project + + + Perl + + Perl + new project + + + Python + + Python + new project + + + Ruby + + Ruby + new project + + + Shell (Scripts for the Bash Shell) + + Bash + new project + + shell + new project + + + + +To be precise, these folders do not contain real programming tools actually. They do lead to pre-defined templates you can use as a starting point for development in that language. To get an idea of what is provided, just open the folders one after the other. There will be a series of subfolders on some, one or more simple entries only on others. The subfolders you see organize the available templates according to some tasks, the simple entries name the templates you may select. + + +We cannot go into detail here on which tasks each template provides, but it's easy to find out. Whenever you select a template entry some information is displayed in the fields to the right. In the lower field you will find a short description on what the template is supposed to do. In the field above that a picture will be shown, if available, about the outcome of the application this template produces if you compile and run it unmodified. Usually this is a screenshot of the main window the application will display. + + +Select the template which best fits your application's goals as a starting point. Then enter the general properties information in the lower field as shown in the next chapter. + + + +Selecting a Project Management System + +Each template is bound to a specific Project Management System. Currently there is no direct means to freely select such a Project Management System. You have to find a template which suits your needs or alter your project accordingly after creation. + + + + + + +Provide General Information + + + project + properties + + properties + + application + name + + name + application + + project + directory + + directory + project + + path + new project + + project + author + + project + email + + author + + email + + project + main.cpp + + main.cpp + + project + license + + license + + +The lower part of the Create New Project dialog General page is a framed field labeled Properties. You must provide some general information about your project here so that the &appwizard; knows how to build the initial structure. + + +Application Name + +Your application needs a name of course. Enter this in the uppermost Properties field, called Application Name. We use MyApp as an example. + + + +When you do so, you will notice that the &appwizard; refuses to accept special characters of any kind. The only characters accepted are: + + upper and lower case characters + numbers + the underline character + + + +One prominent cause of this restriction is that the &appwizard; will use this application name as the basis of some class names it will construct when it sets up an initial project. Thus the name of the application must stick to the rules of the programming language you use. + + +The Project Directory + +The other prominent cause of this restriction you can see at the bottom line of the Properties area. It is labeled Final location and shows the directory where the &appwizard; will create the application. + + + +As you type the application name you will notice that the &appwizard; repeats your input at the end of the Final location line, using lower case only characters. + + +Thus you must select the name of your new application with care. If you end up with an already used directory the &appwizard; will not allow you to continue to the next step, keeping the Next > button deactivated (grayed). Yet, it will warn you in this case by appending (dir/file already exist) to the Final location line. + + + +The Starting Path + +There are two ways to select another path for your new application. One is to select another name. Yet, this is not always feasible (you might ⪚ set up for another version of an already existing application). As an alternative you may select another path to the application directory. + + + +This is done in the second row input field of the Properties, named Location. What you enter here is the starting path of the new application development directory. The &appwizard; appends the application name to this path when it initializes the new project. The result is shown in the Final location line to give you better control on what is going on. + + +&appwizard; will copy an initial value to the Location field on start-up. This is taken from what you have chosen in the Default projects directory field during the general configuration steps. In our case we have &kdevelop; set up to use /home/devel/projects/ as initial path for new projects. + + +Alter the Location field contents so that the application development directory shown in the Final location line will be unique. + + + +Take care that the path you enter in the Location field already exists. Otherwise you will not be able to continue to the next step. The &appwizard; will warn you about non-existing paths by appending (invalid) to the Final location line. + + + + + + + + + Set new project up for CVS + + + + + +Personal Information + +The fields following this are not so critical. Just supply your name (&ie; the name of the person who is responsible for the application) in the Author field, and a valid e-mail address in the Email field, so that users can give you feedback on the application. + + + + + + + The &appwizard; fills these fields with some default values, taken from + the Email presets in the &kcontrolcenter;. If these defaults in the Create New Project Author and Email fields do not suit, you may want to have a look at your mail configuration in the &kcontrolcenter;. + + + The &appwizard; will integrate this information into the starting program templates if applicable. In &kde; C++ programs for instance you will find it near the beginning of the main.cpp source file. + + + Of all fields, the Email is optional, reflecting the fact that not every developer may have access to the internet. You may keep this field empty if you wish and proceed nevertheless. + + + + + +Version and License Info + +Finally enter a starting version number for your new application in the Version field, and select the license under which you want your application be put from the License tab. + + + + +If you select an application type for which the &appwizard; provides common source template texts (⪚ C/C++), you may view the license notification text on the third page of this Create New Project dialog (see the Supply header/source templates chapter below). + + +If you selected Custom from the License tab you must provide a license text on your own. + + + +Both version and license information will as well be integrated into the starting templates in a suiting format the application type you selected does provide. + + + +Once you have correctly entered all this information stuff, press the Next > button to proceed as shown in the following chapters. + + + + + + +Supply Version System Information + + + CVS + new project + + project + CVS + + database + CVS + + version + database + + version + CVS + + +In a second step the &appwizard; will lead you to the Version Control System page where you can decide which version control system you want to use. + + + +This discussion concentrates on the needs for project creation only. For more information on &CVS; see the Using &CVS; chapter below. + + + +No Version Control System Wanted + +Initially there is None selected in the Version control system tab, and the page will be empty otherwise. If you don't want to use a version control system, just click the Next > button and go on. + + + + +Using &CVS; + +Otherwise you must reselect the version control system you want to use from the Version control system tab. We use &cvs; for our example. If you select this, the &appwizard; will redisplay the page, now showing a series of fields you must fill in. + + + + + + + + + + Set new project up for CVS + + + + + +A version control system such as &CVS; (which means Concurrent Versions System) stores copies of selected project files in some sort of a database. If you use &CVS; you can amongst others upload (commit) those files or load them back into your project directory (checkout, or update). The special thing about this is that the files in the versioning database are stored in a structured way which allows you to always revert to an earlier development state if you need so. And &CVS; allows multiple designers to fairly easily collaborate on a big project (such as &kdevelop;) without disturbing each others work. + + + + CVS + root + + root + CVS + + CVS + local + + CVS + remote + + local CVS + + :local: + + CVS + :local: + + +&CVS; Root + +&CVS; needs to manage the versioning database it keeps from your project files. To accomplish this it keeps some special database information in an own directory, called the &CVS; root. The first step on setting up &CVS; for your new project thus is to tell &kdevelop; where this root is located. + + + + +Local &CVS; root. There are two basic possibilities. Either you want to use a local &CVS; database or you use a database which is held on a remote server. If you develop for your own, you may want use the &CVS; database as some sort of a backup system on your own computer. Usually this is set up in your home directory root and given the name cvsroot. This may look as follows: + +/home/devel/cvsroot (where devel simply denotes the developing user, just for example) + + + +In fact, this is a short form. Exactly, the local &CVS; root should be addressed using the :local: prefix. The short form is only allowed in cases where the filename starts with a slash (/). The full name for our example local &CVS; root would exactly look like: :local:/home/devel/cvsroot + + + +Enter the name of the &CVS; root directory your system has been set up for in the CVS root field. In principle you can select any name, even use multiple &CVS; databases, but it is advisable that you stick to the &CVS; root once set up. + + +Initialize a new &CVS; root. If there does not exist a &CVS; root yet, &kdevelop; can command the &CVS; system to create one for you in the given directory. Just check the Init root checkbox below the CVS root field. + + +As said, &kdevelop; only commands the &CVS; system to initialize a new &CVS; root. It does nothing by itself to this directory. Fortunately &CVS; is clever enough to check whether the &CVS; root directory already exists. Hence it does no harm if you should have inadvertently checked Init root on an already existing &CVS; root directory. + + + +Remote &CVS; root. There are occasions where the &CVS; database is to be kept on a remote server, especially when several developers work at the same project. Then you must enter the &CVS; root &URL; of this server in the CVS root field. For example, if you want access to the &kde; &CVS; server: + + +:pserver:mylogin@cvs.kde.org:/home/kde (where mylogin denotes the login name set up in your &kde; &CVS; account) + + + + remote CVS + + :pserver: + + :ext: + + CVS + :local: + + CVS + :pserver: + + CVS + :ext: + + +Remote &CVS; Server Types + +Basically there are two widely used remote &CVS; server types, the +pserver which uses a password-secured non-encrypted +protocol, and the ext server which uses an rsh or ssh +encrypted data transfer. They are distinguished by the &URL; prefix they use: + + + +:pserver: + + +for the password protected server non-encrypted type, and + + +:ext: + + +for an rsh or ssh encrypted server type. For example + + +:ext:mylogin@cvs.cervisia.sourceforge.net:/cvsroot/cervisia + + +accesses the &CVS; root of the widely used Cervisia &CVS; management tool on the SourceForge server. + + +If you want to use an rsh or ssh encrypted server for &CVS; access you must tell &kdevelop; the encryption protocol to be used. Just enter rsh or ssh in the CVS_RSH field of the Create New Project Version Control System page. + + + +There is a caveat if you use an encrypted server for &CVS; from within &kdevelop;. See the Using &CVS; chapter for details. + + + + CVS + repository + + repository + CVS + + +The &CVS; Repository + +So far you have told &kdevelop; where the &CVS; root resides which manages the versioning database and how to access it. Now you need to tell &kdevelop; under which name you want &CVS; save your project files in that database. Such a place your project files will be held in &CVS; is called a repository. + + + +In principle you can use any name for the &CVS; repository of your project files as long as it adheres to the specifications of naming a file. Yet, most developers simply use the name of the application itself. &CVS; will build a directory with this name in the &CVS; root, hence it is more easily found if you keep the application name for it. + + +Just enter the repository name you want to use in the CVS repository field of the Create New Project Version Control System page. In our example this is: MyApp + + + +Take care not to use a repository which already exists! The &CVS; system does not warn about duplicate files but will shovel everything in which does not produce a formal conflict. You will mess up everything! + + + +The Remaining Fields + +There is not much work left to do. &appwizard; has already set up the remaining fields for you. In detail: + + + +The Vendor field is used for compatibility reasons only. You can stick to the vendor default the &appwizard; puts in here. + + +The Message field allows you to comment the initial &CVS; contents. Use any text you like or just stick to the new project default the &appwizard; did put in. + + +The Release tag holds the name which tags the initial state of your project. Such a tag names a certain point within the &CVS; repository by which you can later access this state of your development. (See more in the Using &CVS; chapter.) + + +The &appwizard; has put a default start tag in here which is a worthy proposal. Just stick to it. + + + + +When any information of all these is wrong &kdevelop; usually will not know about until project construction time. It is the &CVS; system which will figure out those errors when it tries to build the repository. Hence you must keep an eye to the Messages window of &kdevelop; when the project is created in the final setup step. If anything was in error with &CVS; you will in most cases see an error message like this: + + + +* cd '/home/devel/test' && cvs -d '/home/devel/mycvsroot' \ + import -m 'new project' '' 'vendor' 'start' &&\ + sh /opt/kde3/share/apps/kdevcvs/buildcvs.sh . '' \ + '/home/devel/mycvsroot' +* cvs [import aborted]: /home/devel/mycvsroot/CVSROOT: No such file or + directory +* *** Exited with status: 1 *** + + + +If this happens you will have to either manually set up &CVS; (&kdevelop; should have successfully initialized your project files at this time) or delete the project directory and start over again with New Project from the Project menu. + + + + +After you have entered all &CVS; related information, click the Next > to go on. + + + +If you want to correct an error on the previous Create New Project page, just press the < Back button. The &appwizard; will remember your settings on the current page, so you can easily proceed when you come back. + + + + + +Supply Header/Source Templates + + +The next step brings you to a series of pages where you can set up common information you want to include in your source and header files, if the task at hand allows. + + +Both header and source templates are provided for C and C++ applications, each on its own page. For other languages there may be source templates only. And in some cases you will even find this template page empty. + + +If the page is used, &appwizard; will fill in some common header comment which for a C++ based application might look like: + + + +/*************************************************************************** + * Copyright (C) 2003 by Your Name * + * you@you.com * + * * + * This program is free software; you can redistribute it and/or modify * + * it under the terms of the GNU General Public License as published by * + * the Free Software Foundation; either version 2 of the License, or * + * (at your option) any later version. * + * * + * This program 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 General Public License for more details. * + * * + * You should have received a copy of the GNU General Public License * + * along with this program; if not, write to the * + * Free Software Foundation, Inc., * + * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * + ***************************************************************************/ + + + +Other templates will provide similar information in a format according to the definitions of the programming language you want to use. + + +As you might have noticed, the applications manager did readily fill in some information you provided on the first General page of the Create New Project dialog, namely the contents of the Author and Email fields. Also proper license information will have been inserted according to your selection in the License tab. + + + +How to Edit the Templates + + + templates + project + edit + + project + templates + edit + + +The templates you set up in the Create New Project dialog will later be processed whenever you command &kdevelop; to set up a new source and/or header file. The information you provided here will be included at top as a documentation header, before the code parts begin. + + +You are not restricted to plain text however. &kdevelop; knows of several variables which allow you to include actual information in the file. The &appwizard; did in fact use some such variables to insert the Author, Email, and License informations into the initial template text. + + + + +Include &doxygen; File Information + + +If, for example, you want the &doxygen;-built &API; documentation to display some further information about the file's contents in its filenames list, you may include the following lines in the source file template: + + +/** + * \file $MODULE$.cpp + * \brief (put some short descripion here). + **/ + + +Whenever you create a new source file, &kdevelop; will replace the $MODULE$ variable by the name body of the newly created file. For example, if you created a new C++ class named ASimpleTest you will see the following lines in the asimpletest.cpp file: + + +/** + * \file asimpletest.cpp + * \brief (put some short descripion here). + **/ + + +You will still have to provide the short description after the \brief keyword, but part of the job is automatically done for you. + + + + + +The License Text File + + +As another example you could include an explicit hint to the license text you want to use into the template. Use the $LICENSEFILE$ variable for this and add for example this line: + + + +// See $LICENSEFILE$ for the full license text. + + +The &appwizard; will replace the $LICENSEFILE$ with the name of the file where the full license text is to be found, namely: + + +// See COPYING for the full license text. + + +for the GPL license, or + + +// See LICENSE.BSD for the full license text. + + +if you decided to put your application under the BSD license. + + +Thee are of course more variables &kdevelop; knows of. See the Editing the templates section in the Editing tools chapter for what is possible. + + + + + + +The templates you define here will come in effect only after the &appwizard; has created the new project. You will find this information on top of the files you created yourself in the development process. When creating the initial files the &appwizard; will use some predefined standard templates. You will have to manually adapt those initial files to your needs. + + + + + + +Build the Initial Project Files + + + project + new + build + + project + initial build + + +Almost everything is done now. On the last templates page the Next > button will have changed to read Finish now. + + +Think twice before you click on it! You still have the option to revise everything by repeatedly using the < Back button. As the &appwizard; remembers all information you did input so far, it may be advisable for you to take the time and look back once again. In case you use local &CVS;, do not forget to double-check the &CVS; repository name (there should be no subdirectory with that name in the &CVS; root directory already—if it does, try another repository name). + + +If ever you don't want the new project be built, abort the Create New Project dialog by the Cancel button. Otherwise click Finish and watch in the Messages window how the &appwizard; initiates the project. + + +If you want to use a versioning system (&CVS;) there will be two runs actually. &appwizard; will first build the project directories and files and then call up the &CVS; program which restarts the Messages window with its own contents. If any error occurs in either of these runs, the process will stop showing you an according error message in the window. + + + +In many cases when your new project has been set up this way, &kdevelop; will automatically load the source file(s) of one or more basically important modules so you can readily start work. (Which source modules will be displayed—if any at all—however depends on the template initially selected in the &appwizard;.) + + + +Do not forget to initially check what the &appwizard; has provided. For example you may want to change the initial heading informations according to your own templates. Usually you will find these in a templates subdirectory in your project directory. Some simple copy operations will mostly suffice. + + +Then it is advisable that you compile the initial project before you attempt to change any code. In most cases this initial compilation should be possible. Thus you can make up whether the project really was set up according to your needs. If it was not, simply remove the project directory (in your local &CVS; root as well if you use one) and start over again. + + + + + + default build configuration + warning + + build configurations + default build warning + + warning + default build configuration + + + Before you compile your new project the first time, have a look at Project Build Configuration. If there are three selections displayed: default, optimized, and debug, with debug selected, by all means stick to this, or use optimized instead. + + + Due to some limitations in the current autoconf/automake setup you should by no means build in the default configuration. This will corrupt some internal directory settings, thus making configure complain when you try to use it in the optimized, or debug build configuration afterwards. + + + (This applies to these multiselection capabilities only. If the application type you selected provides a default build configuration only, you should of course use this one.) + + + + + + + + +Configuring Projects + +(... to be written ...) + + + + diff --git a/doc/kdevelop/automake-file-popup.png b/doc/kdevelop/automake-file-popup.png new file mode 100644 index 00000000..e40f7108 Binary files /dev/null and b/doc/kdevelop/automake-file-popup.png differ diff --git a/doc/kdevelop/automake-manager.png b/doc/kdevelop/automake-manager.png new file mode 100644 index 00000000..5e3a9907 Binary files /dev/null and b/doc/kdevelop/automake-manager.png differ diff --git a/doc/kdevelop/automake-subproject-popup.png b/doc/kdevelop/automake-subproject-popup.png new file mode 100644 index 00000000..e795be9b Binary files /dev/null and b/doc/kdevelop/automake-subproject-popup.png differ diff --git a/doc/kdevelop/automake-target-popup.png b/doc/kdevelop/automake-target-popup.png new file mode 100644 index 00000000..a561e4cc Binary files /dev/null and b/doc/kdevelop/automake-target-popup.png differ diff --git a/doc/kdevelop/automakemanager.png b/doc/kdevelop/automakemanager.png new file mode 100644 index 00000000..89891748 Binary files /dev/null and b/doc/kdevelop/automakemanager.png differ diff --git a/doc/kdevelop/build-commands.png b/doc/kdevelop/build-commands.png new file mode 100644 index 00000000..a6ed86e9 Binary files /dev/null and b/doc/kdevelop/build-commands.png differ diff --git a/doc/kdevelop/build-configurations.png b/doc/kdevelop/build-configurations.png new file mode 100644 index 00000000..6194255e Binary files /dev/null and b/doc/kdevelop/build-configurations.png differ diff --git a/doc/kdevelop/build-menu-automake.png b/doc/kdevelop/build-menu-automake.png new file mode 100644 index 00000000..e468bb78 Binary files /dev/null and b/doc/kdevelop/build-menu-automake.png differ diff --git a/doc/kdevelop/build-menu.png b/doc/kdevelop/build-menu.png new file mode 100644 index 00000000..20353cb5 Binary files /dev/null and b/doc/kdevelop/build-menu.png differ diff --git a/doc/kdevelop/class-browsers.docbook b/doc/kdevelop/class-browsers.docbook new file mode 100644 index 00000000..7c251ee1 --- /dev/null +++ b/doc/kdevelop/class-browsers.docbook @@ -0,0 +1,90 @@ + +The Class Browsers +class browser + + +When working on a project in an object-oriented language, your emphasis when +working on a project is not on the source files and their names, but on the +classes and their relationships. In order to help you navigating in the space +of defined classes and symbols, &kdevelop; includes various class browsers +that visualize the class structure in different ways. + + + +Class View + + +This view is shown on the left side of the main window and contains a linear +list of all classes, variables and functions in your project. It is designed +as a tree view. If you open a class node by clicking on it, a list with all +methods and attributes of the respective class is shown. + + +
+A Screenshot of the Class View + + + +
+ + +The class view works in two different modes. By default, all symbols are +grouped into Classes, Structs, +Functions, Variables and +Namespaces. In the context menu of the view, you can choose +List by Namespaces. In this mode, the namespace +hierarchy is shown and the symbols grouped into the respective namespace +where they are defined. This may be more useful in projects which make heavy +use of (nested) namespaces. It is less useful in projects without +namespaces. + + + +You can also change the way in which class names are displayed. Normally, the +names of the classes are shown, without the namespace in which they are defined. +This means, you cannot immediately distinguish classes with the same name in +different namespaces. If you rest for a while with the mouse over an item, the +full scoped name is shown as a tooltip though. You can decide to always +display the fully scoped class name by choosing +Full Identifier scopes from the context menu. + + + +Clicking on a class or method in the class view brings you to its definition. +You can also jump to the declaration of a method by choosing +Go to declaration from the context menu. In the +context menu for classes are also the items +Add method... and +Add attribute.... This opens dialogs where you can +generate new method and variable declaration in the respective class, together +with an empty implementation. + + + + + + + +Class Tools + + +The class tool dialog is activated by right clicking on a class in the class +view and choosing Class tool.... + + + + + + + +Class Hierarchy + + +(... to be written ...) + + + + + + + diff --git a/doc/kdevelop/classview.png b/doc/kdevelop/classview.png new file mode 100644 index 00000000..34e3707d Binary files /dev/null and b/doc/kdevelop/classview.png differ diff --git a/doc/kdevelop/commands.docbook b/doc/kdevelop/commands.docbook new file mode 100644 index 00000000..31fff849 --- /dev/null +++ b/doc/kdevelop/commands.docbook @@ -0,0 +1,1989 @@ + + + + + + + Volker Paul + + + + 2005-04-03 + + +Command Reference + + + The shortcut key combinations shown in this chapter are the default ones. They can be changed. + + + + + +The Menubar Note that some menu entries only appear when +they are applicable. Especially, some entries are linked to +plugin +functionality which is only available when the plugin is enabled. + + + + + + + + + +The <guimenu>File</guimenu> Menu + + + + + +&Ctrl;N + +File +New + +Create a new file. +The user is prompted to select the directory (default: the current project's +source directory) and enter a file name. The file type can be selected from a list. +Also, the user can choose whether the file is to be added to the project. +Then the Automake Manager asks which target to add the new file to. + + + + + + +&Ctrl;O + +File +Open + +Open an existing file in a simple dialog +box. + + + + + +&Ctrl;O + +File +Open Recent + +Displays a submenu showing the files recently opened. +Selecting one of these will make KDevelop open that file. + + + + + + +&Alt;&Ctrl;O + +File +Quick Open + +Presents a list of files in the current project's +source directory. The user can select from this list +or type a filename. That file is then opened. + + + + + + + +&Ctrl;S + +File +Save + +Saves the current file. + + + + + + +&Ctrl;S + +File +Save As... + +Uses the +Save As... dialog box to let you save a copy +under a new name. + + + + +File +Save All + +Saves all open files. + + + + +F5 +File +Reload + +Reloads current file to show changes +made by different programs. +(Note that such changes are normally detected automatically +and the user is prompted whether the file is to be reloaded.) +. + + + + +File +Revert all + + +Reverts all changes in opened files. +Prompts to save changes so the +reversion can be canceled for each +modified file. + + + + + + + +&Ctrl;P + +File +Print... + +Print. + + + + +File +Export + + +Export + + + + + + + +&Ctrl;F4 + +File +Close + + +Closes current file. + + + + + + +File +Close All + + +Closes all open files. + + + + + + +File +Close All Others + + +Closes all files except the current one. +Very useful if you opened a lot of files and you want +to concentrate on the current one. +Without this, you would have to close them all +and re-open the current one. + +Note there is a similar command in the Window menu. + + + + + + + +&Ctrl;Q + +File +Quit + +Close KDevelop. + + + + + + + + + + + + +The <guimenu>Edit</guimenu> Menu + + + + + + + + +&Ctrl;Z + +Edit +Undo + + +Undo + + + + + + + +&Ctrl;&Shift;Z + +Edit +Redo + + +Redo + + + + + + + +&Ctrl;X + +Edit +Cut + + +Cut + + + + + + + +&Ctrl;C + +Edit +Copy + + +Copy + + + + + + + +&Ctrl;V + +Edit +Paste + + +Paste + + + + + + + +&Ctrl;A + +Edit +Select All + + +Select All + + + + + + + +&Ctrl;&Shift;A + +Edit +Deselect + + +Deselect + + + + + + + +&Ctrl;&Shift;B + +Edit +Block Selection Mode + + +Block Selection Mode + + + + + + + +Insert + +Edit +Overwrite Mode + + +Overwrite Mode + + + + + + + +&Ctrl;F + +Edit +Find + + +Find + + + + + + + +F3 + +Edit +Find Next + + +Find Next + + + + + + + +&Shift;F3 + +Edit +Find Previous + + +Find Previous + + + + + + + +&Ctrl;R + +Edit +Replace + + +Replace + + + + + + + +&Ctrl;G + +Edit +Go to Line + + +Go to Line + + + + + + + +&Alt;&Ctrl;F + +Edit +Find in Files + + +Find in Files + + + + + + + +&Shift;R + +Edit +Find-Select-Replace + + +Find-Select-Replace + + + + + + +Edit +Reformat Source + + +Reformat Source + + + + + + + +&Ctrl;J + +Edit +Expand Text + + +Expand Text + + + + + + + +&Ctrl;L + +Edit +Expand Abbreviation + + +Expand Abbreviation + + + + + + + +&Ctrl;Space + +Edit +Complete Text + + +Complete Text + + + + + + + +F2 + +Edit +Make Member + + +Make Member + + + + + + + + + + + + + + + +The <guimenu>View</guimenu> Menu + + + + +View +Back + + +Back + + + + + + +View +Forward + + +Forward + + + + + + + +&Ctrl;/ + +View +Switch to... + + +Switch to... + + + + + + + +&Alt;C + +View +Raise Editor + + +Raise Editor + + + + + + + +F4 + +View +Next Error + + +Next Error + + + + + + + +&Shift;F4 + +View +Previous Error + + +Previous Error + + + + + + + +&Shift;F + +View +Full Screen Mode + + +Full Screen Mode + + + + + + + +&Ctrl;F12 + +View +Switch Header/Implementation + + +Switch Header/Implementation + + + + + + +View +Tool Views + + +Tool Views + + + + + + +View +Tool Docks + + +Tool Docks + + + + + + + +F7 + +View +Switch to Command Line + + +Switch to Command Line + + + + + + +View +Schema + + +Schema + + + + + + + +F10 + +View +Dynamic Word Wrap + + +Dynamic Word Wrap + + + + + + +View +Dynamic Word Wrap Indicators + + +Dynamic Word Wrap Indicators + + + + + + +View +Show/Hide Static Word Wrap Marker + + +Show/Hide Static Word Wrap Marker + + + + + + + +F6 + +View +Show/Hide Icon Border + + +Show/Hide Icon Border + + + + + + + +F11 + +View +Show/Hide Line Numbers + + +Show/Hide Line Numbers + + + + + + +View +Show/Hide Scrollbar Marks + + +Show/Hide Scrollbar Marks + + + + + + + +F9 + +View +Show/Hide Folding Marks + + +Show/Hide Folding Marks + + + + + + +View +Code Folding + + +Code Folding + + + + + + +View +Set Encoding + + +Set Encoding + + + + + + + + + + + + + + + + +The <guimenu>Project</guimenu> Menu + + + + + +Project +New Project... + + +New Project... + + + + + + +Project +Open Project... + + +Open Project... + + + + + + +Project +Open Recent Project + + +Open Recent Project + + + + + + +Project +Active Language + + +Active Language + + + + + + +Project +Import Existing Project... + + +Import Existing Project... + + + + + + +Project +New Class... + + +New Class... + + + + + + +Project +Class Inheritance Diagram + + +Class Inheritance Diagram + + + + + + +Project +Add Translation... + + +Add Translation... + + + + + + +Project +Build Configuration + + +Build Configuration + + + + + + +Project +Distribution & Publishing + + +Distribution & Publishing + + + + + + +Project +Project Options... + + +Project Options... + + + + + + +Project +Close Project + + +Close Project + + + + + + + + + + + + + + + +The <guimenu>Project</guimenu> Menu + + + + + + +F8 + +Build +Build Project + + +Build Project + + + + + + + +F7 + +Build +Build Active Target + + +Build Active Target + + + + + + +Build +Compile File + + +Compile File + + + + + + +Build +Run Configure + + +Run Configure + + + + + + +Build +Run automake & friends + + +Run automake & friends + + + + + + +Build +Install + + +Install + + + + + + +Build +Install (as root user) + + +Install (as root user) + + + + + + +Build +Clean project + + +Clean project + + + + + + +Build +Distclean + + +Distclean + + + + + + + +&Shift;F9 + +Build +Make Messages & Merge + + +Make Messages & Merge + + + + + + +Build +Execute Program + + +Execute Program + + + + + + +Build +Build API Documentation + + +Build API Documentation + + + + + + +Build +Clean API Documentation + + +Clean API Documentation + + + + + + + +Escape + +Build +Stop + + +Stop + + + + + + + + + + + + + + + + +The <guimenu>Project</guimenu> Menu + + + + + +Debug +Start + + +Start + + + + + + +Debug +Stop + + +Stop + + + + + + +Debug +Interrupt + + +Interrupt + + + + + + +Debug +Run to Cursor + + +Run to Cursor + + + + + + +Debug +Step Over + + +Step Over + + + + + + +Debug +Step over Instruction + + +Step over Instruction + + + + + + +Debug +Step Into + + +Step Into + + + + + + +Debug +Step into Instruction + + +Step into Instruction + + + + + + +Debug +Step Out + + +Step Out + + + + + + +Debug +Toggle Breakpoint + + +Toggle Breakpoint + + + + + + +Debug +Viewers + + +Viewers + + + + + + +Debug +Examine Core File... + + +Examine Core File... + + + + + + +Debug +Attach to Process + + +Attach to Process + + + + + + +Debug +Valgrind Memory Leak Check + + +Valgrind Memory Leak Check + + + + + + +Debug +Profile with KCachegrind + + +Profile with KCachegrind + + + + + + + + + + + + + + + + + + + +The <guimenu>Bookmarks</guimenu> Menu + + + + + + +&Ctrl;B + +Bookmarks +Set Bookmark + +Add current selection to your +bookmarks. + + + + + +Bookmarks +Clear All Bookmarks + +Clear All Bookmarks. + + + + + + + + + + + + +The <guimenu>Window</guimenu> Menu + + + + + + +&Alt;W +Window +Close Selected Windows... + +Close Selected Windows... + + + + + +&Ctrl;F4 +Window +Close + +Close + + + + +Window +Close All + +Close All + + + + +Window +Close All Others + +Close All Others + + + + + + + + + + + + + + + + +The <guimenu>Tools</guimenu> Menu + + + + +Tools +Read Only Mode + + +Read Only Mode + + + + + + +Tools +Filetype Mode + + +Filetype Mode + + + + + + +Tools +Highlight Mode + + +Highlight Mode + + + + + + +Tools +End of Line + + +End of Line + + + + + + +Tools +Spelling + + +Spelling + + + + + + + +&Ctrl;I + +Tools +Indent + + +Indent + + + + + + + +&Ctrl;&Shift;I + +Tools +unindent + + +unindent + + + + + + +Tools +Clean Indentation + + +Clean Indentation + + + + + + + +&Ctrl;Tab + +Tools +Align + + +Align + + + + + + + +&Ctrl;D + +Tools +Comment + + +Comment + + + + + + + +&Ctrl;&Shift;D + +Tools +Uncomment + + +Uncomment + + + + + + + +&Ctrl;U + +Tools +Uppercase + + +Uppercase + + + + + + + +&Ctrl;&Shift;U + +Tools +Lowercase + + +Lowercase + + + + + + + +&Alt;&Ctrl;U + +Tools +Capitalize + + +Capitalize + + + + + + + +&Ctrl;J + +Tools +Join Lines + + +Join Lines + + + + + + +Tools +Word Wrap Document + + +Word Wrap Document + + + + + + +Tools +Difference Viewer... + + +Difference Viewer... + + + + + + +Tools +Execute Command... + + +Execute Command... + + + + + + +Tools +Filter Selection Through Command... + + +Filters selection through external command using +the Filter plugin. + + + + + + +Tools +Debug Regular Expression... + + +Debug Regular Expression... + + + + + + +Tools +Part Explorer + + +Part Explorer + + + + + + + +&Alt;&Ctrl;C + +Tools +Quick Open Class... + + +Quick Open Class... + + + + + + + +&Alt;&Ctrl;M + +Tools +Quick Open Method... + + +Quick Open Method... + + + + + + + +&Alt;&Ctrl;P + +Tools +Preview Doxygen Output + + +Preview Doxygen Output + + + + + + + +&Ctrl;&Shift;S + +Tools +Document Current Function + + +Document Current Function + + + + + + + + + + + + + + + + +The <guimenu>Settings</guimenu> Menu + + + + + + + +&Ctrl;M +Settings +Show/Hide Menubar + +Show/Hide the menubar. + + + + +Settings +Toolbars + +Opens a sub menu where you can choose to show or hide +the various Toolbars. + + + + +Settings +Show Statusbar + +Show the Statusbar. + + + + +Settings +Configure Shortcuts... + + +Configure Shortcuts... + + + + + + +Settings +Configure Toolbar... + + +Configure Toolbar... + + + + + + +Settings +Configure Notifications... + + +Configure Notifications... + + + + + + +Settings +Configure Editor... + + +Configure Editor... + + + + + + +Settings +Configure KDevelop... + + +Configure KDevelop... + + + + + + + + + + + + + + + +The <guimenu>Help</guimenu> Menu + + + + + +Help +KDevelop Handbook + +View this document. + + + + + +&Shift;F1 +Help +What's This? + +Draws a question mark (?) beside the mouse +pointer, clicking on a window item such as the +Stop button will then display a brief explanation. + + + + + + + +Help +Tip of the Day + + +Tip of the Day + + + + + + + +&Alt;&Ctrl;I + +Help +Look in Documentation Index... + + +Look in Documentation Index... + + + + + + + +&Alt;&Ctrl;S + +Help +Search in Documentation... + + +Search in Documentation... + + + + + + +Help +Man Page... + + +Man Page... + + + + + + +Help +Info Page... + + +Info Page... + + + + + + +Help +Report Bug... + +Report bug. + + + + +Help +About KDevelop... + +Display some brief information about +KDevelop's version number, authors and license agreement. + + + + +Help +About KDE... + +Show some information about the version of &kde; that +you are running. + + + + + + + + + + + + + + diff --git a/doc/kdevelop/configure-adddialog-baselibs.png b/doc/kdevelop/configure-adddialog-baselibs.png new file mode 100644 index 00000000..6d97097c Binary files /dev/null and b/doc/kdevelop/configure-adddialog-baselibs.png differ diff --git a/doc/kdevelop/configure-adddialog-qt.png b/doc/kdevelop/configure-adddialog-qt.png new file mode 100644 index 00000000..3138d416 Binary files /dev/null and b/doc/kdevelop/configure-adddialog-qt.png differ diff --git a/doc/kdevelop/configure-adddialog.png b/doc/kdevelop/configure-adddialog.png new file mode 100644 index 00000000..6ebd62d5 Binary files /dev/null and b/doc/kdevelop/configure-adddialog.png differ diff --git a/doc/kdevelop/configure-doctree-DevHelp.png b/doc/kdevelop/configure-doctree-DevHelp.png new file mode 100644 index 00000000..0cf26aeb Binary files /dev/null and b/doc/kdevelop/configure-doctree-DevHelp.png differ diff --git a/doc/kdevelop/configure-doctree-TOC.png b/doc/kdevelop/configure-doctree-TOC.png new file mode 100644 index 00000000..cec94cd6 Binary files /dev/null and b/doc/kdevelop/configure-doctree-TOC.png differ diff --git a/doc/kdevelop/configure-doctree-bookmark.png b/doc/kdevelop/configure-doctree-bookmark.png new file mode 100644 index 00000000..152ee605 Binary files /dev/null and b/doc/kdevelop/configure-doctree-bookmark.png differ diff --git a/doc/kdevelop/configure-doctree-general.png b/doc/kdevelop/configure-doctree-general.png new file mode 100644 index 00000000..abf8be8c Binary files /dev/null and b/doc/kdevelop/configure-doctree-general.png differ diff --git a/doc/kdevelop/configure-doctree-textsearch.png b/doc/kdevelop/configure-doctree-textsearch.png new file mode 100644 index 00000000..680f5137 Binary files /dev/null and b/doc/kdevelop/configure-doctree-textsearch.png differ diff --git a/doc/kdevelop/configure-docu-chm.png b/doc/kdevelop/configure-docu-chm.png new file mode 100644 index 00000000..6456580a Binary files /dev/null and b/doc/kdevelop/configure-docu-chm.png differ diff --git a/doc/kdevelop/configure-docu-custom.png b/doc/kdevelop/configure-docu-custom.png new file mode 100644 index 00000000..25e3bb6d Binary files /dev/null and b/doc/kdevelop/configure-docu-custom.png differ diff --git a/doc/kdevelop/configure-docu-devhelp.png b/doc/kdevelop/configure-docu-devhelp.png new file mode 100644 index 00000000..b7db6634 Binary files /dev/null and b/doc/kdevelop/configure-docu-devhelp.png differ diff --git a/doc/kdevelop/configure-docu-dox.png b/doc/kdevelop/configure-docu-dox.png new file mode 100644 index 00000000..916e32b8 Binary files /dev/null and b/doc/kdevelop/configure-docu-dox.png differ diff --git a/doc/kdevelop/configure-docu-edit.png b/doc/kdevelop/configure-docu-edit.png new file mode 100644 index 00000000..bc904327 Binary files /dev/null and b/doc/kdevelop/configure-docu-edit.png differ diff --git a/doc/kdevelop/configure-docu-general.png b/doc/kdevelop/configure-docu-general.png new file mode 100644 index 00000000..0feaef99 Binary files /dev/null and b/doc/kdevelop/configure-docu-general.png differ diff --git a/doc/kdevelop/configure-docu-indexgen.png b/doc/kdevelop/configure-docu-indexgen.png new file mode 100644 index 00000000..4315b6c3 Binary files /dev/null and b/doc/kdevelop/configure-docu-indexgen.png differ diff --git a/doc/kdevelop/configure-docu-toc.png b/doc/kdevelop/configure-docu-toc.png new file mode 100644 index 00000000..5f5bfb65 Binary files /dev/null and b/doc/kdevelop/configure-docu-toc.png differ diff --git a/doc/kdevelop/configure-editor.png b/doc/kdevelop/configure-editor.png new file mode 100644 index 00000000..2e4b80fa Binary files /dev/null and b/doc/kdevelop/configure-editor.png differ diff --git a/doc/kdevelop/configure-file-selector.png b/doc/kdevelop/configure-file-selector.png new file mode 100644 index 00000000..7ddcb044 Binary files /dev/null and b/doc/kdevelop/configure-file-selector.png differ diff --git a/doc/kdevelop/configure-file-templates.png b/doc/kdevelop/configure-file-templates.png new file mode 100644 index 00000000..b49fbc77 Binary files /dev/null and b/doc/kdevelop/configure-file-templates.png differ diff --git a/doc/kdevelop/configure-general.png b/doc/kdevelop/configure-general.png new file mode 100644 index 00000000..b8c7268c Binary files /dev/null and b/doc/kdevelop/configure-general.png differ diff --git a/doc/kdevelop/configure-project-buildconfig.png b/doc/kdevelop/configure-project-buildconfig.png new file mode 100644 index 00000000..a0236cd8 Binary files /dev/null and b/doc/kdevelop/configure-project-buildconfig.png differ diff --git a/doc/kdevelop/configure-project-configure.png b/doc/kdevelop/configure-project-configure.png new file mode 100644 index 00000000..c918a48b Binary files /dev/null and b/doc/kdevelop/configure-project-configure.png differ diff --git a/doc/kdevelop/configure-project-cpp.png b/doc/kdevelop/configure-project-cpp.png new file mode 100644 index 00000000..7d29091c Binary files /dev/null and b/doc/kdevelop/configure-project-cpp.png differ diff --git a/doc/kdevelop/configure-project-cppoptions.png b/doc/kdevelop/configure-project-cppoptions.png new file mode 100644 index 00000000..2f51ec88 Binary files /dev/null and b/doc/kdevelop/configure-project-cppoptions.png differ diff --git a/doc/kdevelop/configure-project-doc.png b/doc/kdevelop/configure-project-doc.png new file mode 100644 index 00000000..05b29e6d Binary files /dev/null and b/doc/kdevelop/configure-project-doc.png differ diff --git a/doc/kdevelop/configure-project-make.png b/doc/kdevelop/configure-project-make.png new file mode 100644 index 00000000..17b5f426 Binary files /dev/null and b/doc/kdevelop/configure-project-make.png differ diff --git a/doc/kdevelop/configure-project-run.png b/doc/kdevelop/configure-project-run.png new file mode 100644 index 00000000..6bbef8c6 Binary files /dev/null and b/doc/kdevelop/configure-project-run.png differ diff --git a/doc/kdevelop/configure-select.png b/doc/kdevelop/configure-select.png new file mode 100644 index 00000000..1c272a65 Binary files /dev/null and b/doc/kdevelop/configure-select.png differ diff --git a/doc/kdevelop/configure-snippets.png b/doc/kdevelop/configure-snippets.png new file mode 100644 index 00000000..64a2ca00 Binary files /dev/null and b/doc/kdevelop/configure-snippets.png differ diff --git a/doc/kdevelop/create-new-project-cvs.png b/doc/kdevelop/create-new-project-cvs.png new file mode 100644 index 00000000..a4955ae5 Binary files /dev/null and b/doc/kdevelop/create-new-project-cvs.png differ diff --git a/doc/kdevelop/create-new-project.png b/doc/kdevelop/create-new-project.png new file mode 100644 index 00000000..140d5ebb Binary files /dev/null and b/doc/kdevelop/create-new-project.png differ diff --git a/doc/kdevelop/createnewproject.png b/doc/kdevelop/createnewproject.png new file mode 100644 index 00000000..965a14d1 Binary files /dev/null and b/doc/kdevelop/createnewproject.png differ diff --git a/doc/kdevelop/createnewprojectoptions.png b/doc/kdevelop/createnewprojectoptions.png new file mode 100644 index 00000000..1d515bc3 Binary files /dev/null and b/doc/kdevelop/createnewprojectoptions.png differ diff --git a/doc/kdevelop/credits.docbook b/doc/kdevelop/credits.docbook new file mode 100644 index 00000000..77712cc4 --- /dev/null +++ b/doc/kdevelop/credits.docbook @@ -0,0 +1,24 @@ + +Credits + + +Contributions + + + + + The initial contents of this manual were witten by Bernd Gehrmann bernd@kdevelop.org and Caleb Tennis caleb@aei-tech.com. + + + The Summary of &automanag; and Automake Manager Operation chapters were written by Ian Wadham, ianw@netspace.net.au). + + + + + + + + + + + diff --git a/doc/kdevelop/cvs.docbook b/doc/kdevelop/cvs.docbook new file mode 100644 index 00000000..ccdce4e6 --- /dev/null +++ b/doc/kdevelop/cvs.docbook @@ -0,0 +1,139 @@ + +Using &CVS; +CVS +revision control + + +&CVS; Basics + + +&CVS; is the revision control system which many open source projects - +including &kde; — are using. It stores all sources codes in a central place, +called the repository. From the repository, developers +can check out a current version of the project or snapshots of it at arbitrary +points of time. In contrast to some other revision control systems, it is not +necessary to lock files one wants to work on. So +development can be highly parallelized. + + + +Whenever a developer has finished a task, he commits his +code (accompanied by a log message). &CVS; takes the job to merge the changes +made by several developers. It can of course happen that developers work on +the same piece of code, resulting in a conflicting set of changes (in practice +this occurs seldom, and is often a sign of a lack of communication). In this +case &CVS; rejects a commit; only after all conflicts are resolved, a file can +be committed. + + + +So far, this has been a description of the basic features of &CVS; one usually +has to cope with. But &CVS; can provide a lot more: One can maintain several +branches of a project (⪚ &kde; 1.1.2 and &kde; 2 were branches in &kde;'s +development tree), merge changes from one branch to another, ask for +differences between revisions, the revision history of files &etc; + + + +&CVS; is implemented as a client-server system. As a user, all communication +with the repository goes through the command line program &cvs;. A higher +level user interface is available through frontends like &cervisia; () or TkCVS (). In &kdevelop;, only a small part of the &cvs; +functionality which is important for your daily work can be used directly. + + + +Basic knowledge of &CVS; usage is assumed. In particular, you should know +how to checkout a given project from the repository. We recommend the +book Open Source Development With &CVS; by Karl Fogel which is freely +distributed (except for the non-technical chapters). See +. + + + + + + + +&CVS; Commands in &kdevelop; + + +In the file views, the following context menu items are available: + + + + +Add to Repository + +Prepares the marked file for addition to the repository. The file +is transferred to the repository when you commit it (or the containing +directory) the next time. + + + + + +Remove from Repository + + +Prepares a file for removal from the repository. This also deletes +the file on the local file system, so use this feature with care! + + + + + +Update + + +Runs cvs update to merge any changes from other +users into your working directory. When you use this menu item over +a directory, the update normally happens recursively, except if you +have disabled this in the configuration file .cvsrc. + + + + + +Commit + + +Runs cvs commit to upload any locally made changes +to the repository. Note that you should update before doing this. +Otherwise, when another user has committed his own changes before, +&CVS; may give you an error message. + + + + + + +All these commands are invoked as subprocesses by &kdevelop; without any +further command line options or environment variables. This may be a +problem when the connection with the &CVS; server goes through a +&ssh; connection and requires that you enter your password each time +you commit or update. This is for instance necessary when your project is +hosted on sourceforge.net. Workarounds for this +problem are described on the &CVS;/SSH FAQ which you can find in the +SourceForge documentation. + + + + + + + +Behind the Scenes + + +What &CVS; Records in the Working Directory + + +(... to be written ...) + + + + + + diff --git a/doc/kdevelop/debugger.docbook b/doc/kdevelop/debugger.docbook new file mode 100644 index 00000000..a06f2c83 --- /dev/null +++ b/doc/kdevelop/debugger.docbook @@ -0,0 +1,242 @@ + +The Debugger Interface +debugger + + +For C and C++, &kdevelop; contains an internal debugger that is directly +integrated with the editor. Technically, it is implemented as a frontend +that uses the portable &GNU; debugger gdb through +a pipe. The debugger can be started in several ways: + + + + + +With DebugStart, +the main program of your project is loaded into the debugger. + + + + + +Using Debug +Start (other) +Examine core file you load a core file +into memory, which is generated by the operating system kernel when the +program has crashed (The generation of core files may be switched off on your +system, see ulimit(1)). This is useful for a +post-mortem analysis of a program. + + + + + +With Debug +Start (other) +Attach to process you invoke the +debugger on an already running program. You will be shown a +process list where you can select the process which the debugger +should take over. + + + + + +Note that debugging is only possible if your project has been compiled with +debugging information enabled. It can be activated in the +Compiler options dialog. When this option is switched +on, the compiler generates additional data which allows the debugger to +associate file names and line numbers with addresses in the executable. + + + + + +The debugger frontend offers several views into the process: + + +If you try to debug a project without debugging information, you get +the message No source... in the status +bar.If you try to set a breakpoint, it is shown as Pending +(add) in the breakpoint window (see below). + + + + +Variables + +watch variables + +This window lists the values of all local variables at the current execution +point of the program. It covers the variables in the complete call stack, +&ie; the function where the process was interrupted, the function that called +this function, and so on up to main() function. + + + +Another branch in the variables contains watch variables. You can configure +yourself which variables are shown here. Both local and global variables can +be watched. You can add variables either by clicking on the +Add button or pressing Return while +the Watch item is selected. They can be removed again +via the context menu. + + + + + +Frame Stack + +frame stack + +(... to be written ...) + + + + + +Breakpoints + +breakpoints + +This window allows you to see and manipulate the breakpoints. Remember that +&kdevelop; uses GDB, so to fully understand the +&kdevelop; debugging features, you should know a little bit about the GDB. + + +If you want to look at the source code, breakpoints are defined in +kdevelop/languages/cpp/debugger/breakpoint.h. + + +At the left edge, the window has buttons to: + + +Add an empty breakpoint +Edit the selected breakpoint + Delete the selected breakpoint +Remove all breakpoints + + +The main part of the window is a table with 7 columns. Each line in +the table is a breakpoint. The columns are: + + +Selection checkbox +Type: one of: Invalid, File:Line, Watchpoint, Address, Function +Status. Values are: + + Active + Disabled: Each breakpoint may be enabled or + disabled; if disabled, it has no effect on your program until + you enable it again. + Pending (add): a breakpoint is marked like this if no + debugging information is available. From GDB Info page: +
If a specified breakpoint location cannot be found, it may be due to + the fact that the location is in a shared library that is yet to be + loaded. In such a case, you may want GDB to create a special + breakpoint (known as a pending breakpoint) that attempts to resolve + itself in the future when an appropriate shared library gets loaded. +
+ + + +Pending (clear) +Pending (modify) +Location in the format filename:linenumber +Condition +Ignore Count: If this is a number COUNT +greater than zero, the next COUNT times the breakpoint is +reached, your program's execution does not stop; other than to decrement the +ignore count, gdb takes no action. +Hits: counts how many times a breakopint has been hit. + + + + + + + +Disassemble + +disassemble +(... to be written ...) + + + + + + + +Setting Breakpoints + + +(... to be written ...) + + + + + + + +Options + + + +Display Mangled Names + +name mangling +manglingname + + +In C++, function names in the executable are mangled, &ie; +the function names include information about the argument types. This is +necessary in order to support overloading of functions. The mangling +algorithm is not standardized and differs even between different versions of +the &GNU; C++ compiler. + + + +In the disassembling window, normally unmangled names are displayed, so +function signatures appear in the similar way as in the source code, so +they are easily readable. Alternatively, you can decide to see mangled names. + + + + + +Try Setting Breakpoints on Lib Load + +lazy breakpoints +breakpointslazy + + +The debugger backend gdb does not allow to set +breakpoints within code that is not currently loaded. In a highly modular +application, where often code is only loaded on demand as a plugin (using +the libc function dlopen(3)), this can be inconvenient. +Therefore, &kdevelop; rolls its own support for breakpoints in shared +libraries. If you set this option, it allows you to set breakpoints in +libraries which are not loaded. Then, whenever gdb +notifies that a library is loaded, &kdevelop; tries to set the pending +breakpoints. + + + + + +Enable Floating Toolbar + +debugger toolbar +toolbardebugger + + +(... to be written ...) + + + + + + + + diff --git a/doc/kdevelop/doctree-add-bookmark.png b/doc/kdevelop/doctree-add-bookmark.png new file mode 100644 index 00000000..090c93f9 Binary files /dev/null and b/doc/kdevelop/doctree-add-bookmark.png differ diff --git a/doc/kdevelop/doctree-reduced.png b/doc/kdevelop/doctree-reduced.png new file mode 100644 index 00000000..30c22e79 Binary files /dev/null and b/doc/kdevelop/doctree-reduced.png differ diff --git a/doc/kdevelop/doctree.png b/doc/kdevelop/doctree.png new file mode 100644 index 00000000..26264828 Binary files /dev/null and b/doc/kdevelop/doctree.png differ diff --git a/doc/kdevelop/doctreeview.png b/doc/kdevelop/doctreeview.png new file mode 100644 index 00000000..64031238 Binary files /dev/null and b/doc/kdevelop/doctreeview.png differ diff --git a/doc/kdevelop/documentation.docbook b/doc/kdevelop/documentation.docbook new file mode 100644 index 00000000..eed065b0 --- /dev/null +++ b/doc/kdevelop/documentation.docbook @@ -0,0 +1,57 @@ + +Documentation + + +Documention unfortunately belongs to the most-overlooked programming +issues. Yet, once properly set up and maintained internal and external +documentation provides most valuable help. + + + +Documentation has multiple facets. There is + + + project internal documentation, mainly consisting of + + + comments in header/source files + + + internal &API; documentation of your project + generated from the program file by special tools, ⪚ &doxygen; + + + + + project external documentation, comprising among others + + + external &API; documentation of ⪚ common system libraries (&kde;, &Qt;, &etc;) + + + any other documentation (programming language manuals, general system information, how-to articles and the like) + + + + + + +All this documentation should be easily maintainable and ready at hand whenever you need it. &kdevelop; has provisions for just this. + + + + + +The Documentation Browser + + +
+A Screenshot of the Documentation Tree + + + +
+ + + + diff --git a/doc/kdevelop/documents-contents.png b/doc/kdevelop/documents-contents.png new file mode 100644 index 00000000..9adb1699 Binary files /dev/null and b/doc/kdevelop/documents-contents.png differ diff --git a/doc/kdevelop/documents-search.png b/doc/kdevelop/documents-search.png new file mode 100644 index 00000000..f1e23048 Binary files /dev/null and b/doc/kdevelop/documents-search.png differ diff --git a/doc/kdevelop/edit-doctree-TOC-entry.png b/doc/kdevelop/edit-doctree-TOC-entry.png new file mode 100644 index 00000000..f0d56685 Binary files /dev/null and b/doc/kdevelop/edit-doctree-TOC-entry.png differ diff --git a/doc/kdevelop/editing.docbook b/doc/kdevelop/editing.docbook new file mode 100644 index 00000000..54074bdb --- /dev/null +++ b/doc/kdevelop/editing.docbook @@ -0,0 +1,401 @@ + +Editing Tools + + +Code Snippets + + + Features (preliminary overview) + + SnippetPart adds a tool-view which by default docks to the right + + + Adding, editing and removing of snippets is available via a popup-menu + + + Double-clicking a snippet form the list inserts it into to the active view at the current cursor position + + + Tool tips show the content of a snippet + + + Snippets are stored in the users home-directory, so every user can have his own snippets + + + Snippets can contain variables in the style of $VARNAME$. On using the snippet the user is prompted to enter replacement value for the variables + + + + + +Keyboard Mapping +keybindings + + +In the following, we will list the default keybindings of the +default editor. You can configure them as you like (how?) + + + + + + + + Left + + + Moves one character left + + + + Right + + + Moves one character right + + + +&Ctrl; + Left + + + Moves one word left + + + +&Ctrl; + Right + + + Moves one word right + + + + Up + + + Moves up one line + + + + Down + + + Moves down one line + + + + Page Up + + + Moves up one page + + + + Page Down + + + Moves down one page + + +&Ctrl; + Page Down + + + Moves to the beginning of the file + + +&Ctrl; + + Page Down + + + Moves to the end of the file + + + + Home + + + Moves to the beginning of the line + + + + End + + + Moves to the end of the line + + + + + + + +For all the keys above, the &Shift; key can be pressed additionally, +to mark from the current cursor position to the one afterwards. + + + + + + + + Backspace + + + Deletes one character left + + + + Delete + + + Deletes the character under the cursor + + + +&Ctrl; + + C + + + Copies the selected text to the clipboard + + +&Ctrl; + V + + + Pastes the selected text from the clipboard + + +&Ctrl; + X + + + Deletes the selected text and puts it into the clipboard + + +&Ctrl; + Z + + + Undo + + +&Shift;&Ctrl; + Z + + +Redo + + + + + + + + + + + +The Problem Reporter + + +(... to be written ...) + + + + + + +Searching and Grepping +searching +finding + + +Searching for Text + + +&Ctrl;F- Find +&Ctrl;R- Replace + + + + + + +ISearch +isearch +incremental search +searchincremental + + +The conventional search with Edit +Find requires you to specify the full +search term before starting. Most of the time, it is much faster to search +incrementally. If you click into the edit field labeled +ISearch in the toolbar, the search is performed as you +type. You will find that often the desired term is already found after typing +in 3 or 4 letters. + + + + + + +Grep +searchin files + + +Both search mechanisms described above are restricted to searching within one +source file. An additional tool which allows you to search through a (possibly +large) number of files is available through the +Search in Files... item in the +Edit menu. It is basically a frontend for the +&grep;(1) program. + + + +In the dialog, you can specify which files are searched. There is a number of +wildcard patterns available in a combobox. In this way, you can easily +restrict the find mechanism to header files. Furthermore, you specify a +directory where the search is started. If you check the +Recursive box, the search iterates through all +directories in the hierarchy below this one. + + + +The search term is in general a regular expression following POSIX syntax. +For example, you can use the term "\<K.*" if you want to +find all words which begin with the letter K. The following characters +are interpreted in a special way: + + + + + + + + . + + Matches any character + + + ^ + +Matches the beginning of a line + + + $ + + Matches the end of a line + + + \< + + Matches the beginning of a word + + + \> + + Matches the end of a word + + + ? + + The preceding item matches less than once + + + * + + The preceding item is matched zero or more times + + + + + + The preceding item is matched once or more times + + + {n} + + The preceding item is matched exactly n times + + + {n,} + + The preceding item is matched n or more times + + + {,n} + + The preceding item matches less than n times + + + {n,m} + + The preceding item matches at least n times but less +than m times + + + + + + + +Backreferences to bracketed subexpressions are also available by the notation +\n. + + + +For C++ programmers, as special bonus there are some search templates +available for typical patterns. These allow you to search for example +all calls of member functions of a certain object. + + + +Once you start the search by clicking on the Search +button, it will be performed by an external, asynchronous process. All found +items will appear in the view called Grep. You can then +jump to the found items by clicking on them. Note that grep scans the files +as they stored in the file system. If you have modified versions of them in +your editor, you may get some mismatches in the line number, or some found +items will be invalid. You can avoid this by saving all files beforehand. + + + + + + + + + +Code Completion + + +(... to be written ...) + + + + + + +Creating New Files and Classes + + +(... to be written ...) + + + +Editing the Templates + + +(... to be written ...) + + + + + + + diff --git a/doc/kdevelop/editor-ctags-lookup.png b/doc/kdevelop/editor-ctags-lookup.png new file mode 100644 index 00000000..f07a1348 Binary files /dev/null and b/doc/kdevelop/editor-ctags-lookup.png differ diff --git a/doc/kdevelop/editor-ctags-menu.png b/doc/kdevelop/editor-ctags-menu.png new file mode 100644 index 00000000..b128b69b Binary files /dev/null and b/doc/kdevelop/editor-ctags-menu.png differ diff --git a/doc/kdevelop/editor-ctags-regenerate.png b/doc/kdevelop/editor-ctags-regenerate.png new file mode 100644 index 00000000..b29cb352 Binary files /dev/null and b/doc/kdevelop/editor-ctags-regenerate.png differ diff --git a/doc/kdevelop/editor-find-menu.png b/doc/kdevelop/editor-find-menu.png new file mode 100644 index 00000000..e71c6d00 Binary files /dev/null and b/doc/kdevelop/editor-find-menu.png differ diff --git a/doc/kdevelop/editor-search-doc.png b/doc/kdevelop/editor-search-doc.png new file mode 100644 index 00000000..ad91da28 Binary files /dev/null and b/doc/kdevelop/editor-search-doc.png differ diff --git a/doc/kdevelop/editor-switch-header.png b/doc/kdevelop/editor-switch-header.png new file mode 100644 index 00000000..76d95c29 Binary files /dev/null and b/doc/kdevelop/editor-switch-header.png differ diff --git a/doc/kdevelop/empty-ide.png b/doc/kdevelop/empty-ide.png new file mode 100644 index 00000000..3cf19981 Binary files /dev/null and b/doc/kdevelop/empty-ide.png differ diff --git a/doc/kdevelop/file-browsers.docbook b/doc/kdevelop/file-browsers.docbook new file mode 100644 index 00000000..f8b37735 --- /dev/null +++ b/doc/kdevelop/file-browsers.docbook @@ -0,0 +1,79 @@ + +The File Browsers + + +On the left side of the main window, &kdevelop; can display various kinds of +lists and trees for the selection of files: + + + + +File Tree + + +This shows a tree view of the file hierarchy below the project directory. If +you click on a file, it is loaded into the editor. For files which do not +contain text, &kdevelop; starts an application that can handle the respective +MIME type. + + + +The file tree is regularly updated whenever something changes in the file +system. For example, if you create new files or directories (even outside +&kdevelop;), this is immediately reflected in the file list. On &Linux;, +this feature makes use of the FAM library. On other operating systems or over +NFS, the directories shown are polled in small intervals. + + + +The file tree hides files which are usually not interesting, like object +files. In the Project options under +File views, you can configure (as a comma separated +list of wildcards) which patterns are used to filter out irrelevant files. + + + +Furthermore, you can decide to restrict the file tree to show only files which +belong to the currently loaded project. This can be toggled by clicking with +the right mouse button on the root item of the tree. + + +
+A Screenshot of the File Tree + + +A Screenshot of the File Tree + +
+ + + + +File Groups + + +This shows the files belonging to the project, grouped by their file name +extension. As in the file tree, you can edit a file by clicking on it +with the &LMB;. + + + +The groups shown in this view can be configured under +File views in the +Project options dialog. In order to customize the +view to your needs, it is helpful to understand how files are distributed on +the groups. For each file, &kdevelop; goes through all groups from top to +bottom. In each group, it looks whether the file name matches one of the +patterns. If there is a match, the file is shown in this group and the +iteration is aborted. This makes it clear that more general patterns should +be put below more specific ones. For example, an asterisk for the +Other group should be the last pattern. + + + + + + + + + diff --git a/doc/kdevelop/file-list-close-selected.png b/doc/kdevelop/file-list-close-selected.png new file mode 100644 index 00000000..18ff8b9b Binary files /dev/null and b/doc/kdevelop/file-list-close-selected.png differ diff --git a/doc/kdevelop/file-list-session-create.png b/doc/kdevelop/file-list-session-create.png new file mode 100644 index 00000000..a80fa37c Binary files /dev/null and b/doc/kdevelop/file-list-session-create.png differ diff --git a/doc/kdevelop/file-list-session-default.png b/doc/kdevelop/file-list-session-default.png new file mode 100644 index 00000000..1eaf565c Binary files /dev/null and b/doc/kdevelop/file-list-session-default.png differ diff --git a/doc/kdevelop/file-selector.png b/doc/kdevelop/file-selector.png new file mode 100644 index 00000000..8a357851 Binary files /dev/null and b/doc/kdevelop/file-selector.png differ diff --git a/doc/kdevelop/filetree.png b/doc/kdevelop/filetree.png new file mode 100644 index 00000000..1e731402 Binary files /dev/null and b/doc/kdevelop/filetree.png differ diff --git a/doc/kdevelop/find-in-files.png b/doc/kdevelop/find-in-files.png new file mode 100644 index 00000000..17dae505 Binary files /dev/null and b/doc/kdevelop/find-in-files.png differ diff --git a/doc/kdevelop/folded-tabs.png b/doc/kdevelop/folded-tabs.png new file mode 100644 index 00000000..1218421f Binary files /dev/null and b/doc/kdevelop/folded-tabs.png differ diff --git a/doc/kdevelop/getting-started.docbook b/doc/kdevelop/getting-started.docbook new file mode 100644 index 00000000..11a08253 --- /dev/null +++ b/doc/kdevelop/getting-started.docbook @@ -0,0 +1,3221 @@ + + + + + + + +BerndPol + + + + +Getting Started with &kdevelop; — a Guided Tour + +Now that you have got your new &kdevelop; &IDE;, how are you going to make +good use of it? As this is a complex application, the learning curve may be +somewhat steep, especially if you are not already used to this type of an +Integrated Development Environment. + +We will try to soften this learning curve a bit by stepping through the +makings of a simple KDE C++ application. Thereby we will have a (cursory) look +at: + + +A first look — the user +interface elements of the &kdevelop; &IDE;. +Doing some initial +configuration. +How to create a new project. + +Some tips about dealing with +documents. +How to compile the application in +this project. +How to add classes and other +detail to your project. +What to do to debug the +application. +Some basic tools to build program or +user documentation. +Last but not least, keyboard +shortcuts + + +Before we start, one important concept should be made clear. + + +What to expect? +As said, &kdevelop; is an Integrated Development +Environment. That means in essence that &kdevelop; is no development +tool by itself but rather a graphical front end to easily access a wide range of +development tools, many of which actually would require complex keyboard +commands run from a text console. + + +While &kdevelop; eases many of those programming tasks, much of the +complexity from this bundle of tools still remains which means that in order to +fully understand the &kdevelop; &IDE; you will still need to comprehend these +tools actually running beneath the surface. + +Hence, we cannot teach you how to build software, but rather introduce you +to some of the ways &kdevelop; was designed to ease such a software building +process. If you want to learn more about what an Integrated Development +Environment is meant for, you might want to have a look at the Development on &UNIX; historical overview and there +especially at the Integrating Concepts and +Tools chapter. + + +The following discussions apply to the default case, where &kdevelop; +starts up in the Simplified IDEAl Window Mode. If you +already did switch to another user interface mode some items may not be there as +described or will behave slightly different. If in doubt which user interface +mode your &kdevelop; currently uses, check with the +Settings Configure +KDevelop... User Interface +dialog. + + + +A Very First Look at &kdevelop; + +This is all about what you will see when you first started &kdevelop;. +You will find preliminary information about: + + +What is there on the +surface? +How to get some +help. +What is in the +menus? +What are those tool views +for? + + + +On the Surface + +When you start &kdevelop; for the first time you will get a display +similar to this one: + + + + + + + +The &kdevelop; initial layout +(Actually the initial &kdevelop; window will be larger, but the elements +you see are the same.) + + + + + +Workspace Area and Tool View Tabs +In this initial case &kdevelop; uses the so-called IDEAl user interface mode. A workspace area of +maximum possible size is surrounded left, bottom, and right by a series of +buttons which act similar to tabs on a tabbed display. If you click on one of +those tabs, a so-called tool view window will open which +allows you to work on a specific task. + + + +Menu and Toolbars +On top there is the usual menubar, followed by several rows of toolbars, +some being initially empty. They will get populated once there is a project open +for actual work. + + + +Status Bar +Finally, there is a status bar on the bottom of the window where short +informations on several tasks will be shown. + + + + +How to Get Some Help + +Besides the Help menu which offers answers to specific +questions, the status bar and two kinds of tool tips provide some quick +information. + + +What Does This Menu Entry Do? +When you place the mouse cursor on a menu entry, there will usually some +short information be displayed in the status bar. While in most cases this +repeats just the name of the selection, in some cases it will provide additional +information about the purpose of the menu command. + + + +What Is the Name of This Item? +On many items a short function name tool tip will pop up when you place +the cursor on it for a few seconds. This is useful for quick orientation on +toolbar or tool view tabs in IDEAl mode when the &IDE; has been set up to +display icons only on these buttons. + + + +What Does This Item Do? +More information is available through expanded tool tip help for many +items on the &IDE;. Select Help +What's This? or press +&Shift;F1, then with the +question mark cursor select the item you want to know more of. You can as well +open any menu this way and click on a specific menu entry (active as well as +greyed disabled ones) to see if more information is available. + + + + +What is in the menus? + +There are ten menus selectable on the menubar. Most of them get fully +populated once a project is open for actual work while others require at least +one document be open in an editor window. In short, they will allow the +following action types. + + +This is only a preliminary overview. For a detailed menu description see +the Command Reference. + + + + +File + + +Usual Actions +This is pretty standard. It allows to create, open, save, print, and close +document files as well as quitting the &kdevelop; application as usual. + + + +Revert All +This allows to revert all recent, yet unsaved changes by reloading the +file from the disk. This works on any file you edit, not only on those which are +part of a project. + + + + + +Edit + +This menu is useful only if a document is opened. + + +Usual Actions +It provides the usual undo/redo and cut/copy/paste actions. +Furthermore it allows to select text blocks in various ways. + + + +Search and Replace +There are two very powerful search facility available, +Edit Find in +Files..., and Edit +Find-Select-Replace.... These allow, in +addition to the usual search and replace actions limited to the the current +document, to conduct global search or search-and-replace actions in one single +turn. + + + +Advanced Text Edit +There are provisions to reformat the current document and to automatically +complete partially typed texts in various ways. + + + + + +View + +Like the Edit menu, this menu is useful only if there +is an open project. I this case there will be the following actions available +(amongst others): + + +Navigation History +Switch back and forth through the documents &etc; you visited. + + + +Error Tracking +Navigate to the source lines of the errors encountered in the most recent +compilation/build process. + + + +Editor Related Actions +Some entries in the View menu control the look and view +of the editor you use. In case of the &kate; Part (Embedded Advanced Text +Editor) there will be the following controls available: + + + + +Control the word wrap behavior in the document window. + + +Show or hide several border displays in the document windows: line +numbers, icons, and, additionally, bookmark marks in the scroll bar. + + +Control the display of folded (temporarily hidden) sections in a source +text. + + + + + + +Project + +All work of &kdevelop; is based on projects which +basically collect source files, build management files, and other information in +one project directory. In this menu you control which project to use, which +properties it has, and some other managing actions. +In particular: + + +Open a Project +Allows to create new projects, open existing ones, and import projects +from other environments. + + + +Project Options +Allows to define a whole bunch of different project properties. + + + +Classes Management +Add new classes to the project and traverse the inheritance tree of a +class. + + + +Distribute Project +Helps to build distribution packages of the project. + + + + + +Build + +This menu is all about compiling and documenting the project. Thus it is +of use only when a project is actually open. In this case it provides the +following actions: + + +Compile, Link, Execute +Allows to compile and link the whole project or parts of it as well as run +the application from within the &IDE;. + + + +Prepare Build Operations +This actually depends on the make system you use for this project. In the +case of automake projects it allows to run Makefile.cvs and +configure on their own. There are also provisions to remove +translated files from the project in various stages of intensity. + + + +Install the Application +Allows to install the application both in local directories as well as in +system directories only accessible to the root user. + + + +API Documentation +Build or remove a doxygen-based API documentation of the project as +defined in the project options. + + + + + +Debug + +Although this menu will be filled once a project is active, it of course +is useful only if the actual project has been previously compiled with debugging +information (this is basically set up in Project +Project Options..). There are the +following actions available in this case: + + +Usual Debugger Actions +The first section in the Debug provides a graphical +interface to the GDB &GNU; symbolic debugger. It allows to start and stop your +application in the debugger and step through it in various ways. + + + +Breakpoints +&kdevelop; provides several means to set breakpoints in your application +sources. One is through the use of the Toggle +Breakpoint menu entry. + + + +Advanced Debugging +Other Debug menu entries allow more sophisticated +program analysis. Use +&Shift;F1 to get more +information about their purpose. + + + + + +Scripts + +You can call various scripts from this menu to more easily accomplish +tedious actions on the text in the currently selected editor window. The +available actions depend on the selected script, however. + + + + + +Window + +This is fairly standard. You may select any open document window as well +as close one or more documents windows in here. You may even select a set of +document windows to be closed in one single turn. + +Depending on the editor plugin you use may there be other menu items as +well. So will the default Kate editor plugin additionally allow to split the +editor window horizontally as well as vertically. + + + + +Tools + +&kdevelop; is highly customizable. +You may select a favorite editor for your documents as well as provide external +and plugged-in tools to extend the basic &IDE; capabilities. The +Tools menu reflects most of this setup. + + +Advanced Editing +The upper set of Tools menu entries will be provided by +the editor plugin which is in use. You may select your favorite editor via +Settings Configure +KDevelop... Editor. Once an +editable document file is selected, the upper part of the +Tools menu will provide advanced editing commands specific to +the editor part in use. + + + +Web Side Handling +In case the active document window contains a HTML page (⪚ displayed +from a Documentation selection), the +Tools will show additional menu entries which provide various +means to handle Web pages. + + + +Other Tools +Usually there will be a bunch of other entries according to the currently +available tools. Use &Shift; +F1 to get more information about their +purposes. + + + + + +Settings + +This menu allows you to show and hide menubar, toolbars and statusbar. +Also, you can configure shortcuts, toolbars, notifications, the editor and +&kdevelop;'s general behavior. + + + + +Help + +Here you can open this KDevelop manual, look up terms in various +documentation files, open man pages (the traditional UNIX manual format) and +info pages (the GNU manual format). Furthermore you can report bugs here or get +some info about your current KDevelop version and its authors. + + + + + + +What are those tool views for? + +In the IDEAl user interface mode the workspace will be surrounded by three +areas of buttons, so-called tool view tabs. They provide +access to tool view windows which accomplish main tasks +during software development. Each of these three tool view areas serves a +different main purpose. + + + + +Left Side +Provides access to navigation and selection tools + + + + + +Bottom +These views display messages produced by various tools. + + + + + +Right Side +Provides access to documentation and source management tools. + + + + +The number of tool view tabs shown will change once a project is open for +actual work. More tools to work on that project will be available then. The +actual number of tool views depends on the Plugin +Tools being currently available to &kdevelop;. You will find more on this +topic in the Configuring KDevelop chapter. + +Currently, with no project open and the default number of plugin tools +loaded, you will find the following tool views. Clicking on a tab will open +respectively close its tool view window. + + + +Navigation and Selection + + +File Selector +Provides a panel to navigate the directory tree and select files for work +just like you do in the &konqueror;. Clicking a file will open it in an +appropriate editor window in the workspace area. A right click in the file +selector area will pop up a navigation and file manipulation menu. + + + +File List +Lists the currently open files. Clicking on a file will usually select its +editor window in the workspace area. Use this to quickly navigate in a large +number of open files. Furthermore this view provides a means to organize the +open files into different sessions. This is particularly +useful in very large and complex projects to help the developer concentrate on +different tasks. Right clicking a file will pop up a file manipulation +menu. + + + + + +Messages Displays + + +Application +Displays the output from an application started from within +&kdevelop;. + + + +Diff +Used to display patch file contents. +Displays the output from the difference viewer tool started from the +Tools Difference +Viewer... menu. + + + +Messages +Displays messages produced by the build tools called from within +&kdevelop;, usually from the Build menu. + + + +Find in Files +Displays the list of items found by the global search operation started +from the Edit Find in +Files... menu. Clicking on a line here will +automatically open that file at the specified position in an editor +window. + + + +Replace +Lists the results of the global search-and-replace operation issued from +the Edit +Find-Select-Replace... menu. In this +view you can decide on every found item whether you really want it be replaced +or not. + + +This global search-and-replace facility is actually available only after a +project has been loaded into &kdevelop;. Otherwise the global replace tool in +the Edit +Find-Select-Replace... menu will in +fact be be disabled. + + + +Konsole +Opens a &kde; Konsole like terminal emulator +window where you can use keyboard commands in a traditional &UNIX; command line +interface. + + + + + +Documentation and Source Manipulation + + +Documentation +&kdevelop; provides access to a whole bunch of documentation through this +tool. You may here access document files, usually online from remote locations, +in a structured way. And there are several ways available to directly access +valuable information from &kde; or &Qt; manuals. + + +See the Documentation and Configuring the Documentation chapters for more +details. + + +Code Snippets +This tool allows you to permanently store selected texts for later use in +other editing cycles. It is a very flexible tool, as any text snipped stored +here may contain a set of variables which will get their actual values at the +time when you insert such a snippet in some other text. + +More information on this is available in the Code Snippets and Setting Up the Code Snippets Tool +chapters. + + + + + + + +A Bit of Configuration + +Before we actually start a first example project, we should tailor the +&kdevelop; behavior to our needs. Although most of the default settings will be +appropriate for now, there are a few places which better should be +adjusted. + + +If you want to know more about &kdevelop; configuration, have a look at +the Configuring KDevelop chapter. + + + +Some General Settings + +To configure &kdevelop;, click the +Settings menu and select +Configure KDevelop.... The +Configure KDevelop dialog will pop up, showing the +following General settings page to the right. + + + + + + + +The &kdevelop; general configuration dialog + + + + +Most of the defaults will be o.k. +But you will probably want to change two of those settings. + + +Default projects directory +At first start of &kdevelop; this will most likely be preset to your home +directory. Most people however prefer a dedicated projects directory for +software development. Change the text box to your preferred parent development +directory. You may select it from the directory tree if you press the +Open file dialog button labeled with a folder icon to the +right of it. + + +In our examples we will assume a (somewhat artificial) user called +devel. +Thus always replace this devel by your user name. Our devel user +will utilize the /home/devel/projects +parent directory for actual development. Again, replace projects with your development directory name. + + +&kdevelop; will by default set up an own subdirectory below this parent +for every new project you create. So will ⪚ all files of a project named +Hello in our case be located in the /home/devel/projects/hello directory. + +You may of course temporarily override these directory settings if you +need to. See the &appwizard; chapter +for more info on this. + + +Compiler output +Whenever &kdevelop; compiles some source, it will display the messages of +the make, etc. build tools in the +Messages window in the lower part of the workspace area. +Usually these messages will be overwhelmingly wordy. To keep a better overview +of what happens, &kdevelop; has some means of shortening those messages built +in. + + +Depending on the &kdevelop; version you use, the Compiler +output selection may be preset to Long, which will +cause all message contents be fully shown. You may probably want to change this +to the far more convenient Very Short setting. Just select this +from the drop down box. + + +Be aware that only most basic information will be +shown in the Messages window this way. In case of errors +during ⪚ a build run you will most likely want to see more, if not all, of +the message texts. They are not lost, however. Just right click into the +Messages window and select ⪚ Full Compiler +Output from the popup menu. + + + + +Initializing Documentation Search Indexes + +There is another, not so obvious, item which preferably should be +initialized before you start actual development work. This is because you will +want to perform documentation search regularly during development. &kdevelop; +requires some search indexes be created before such search operations can be +performed. So let's initialize them before we attempt our first steps +toward actual &kdevelop; work. + +Open the Documentation tool view at the right side of +the &kdevelop; main window. There open the Search dialog +page. + + + + + + +Where to generate the search indexes. + + + +Now press the Update Config button to make sure the +basic search tools are properly set up. A dialog should pop up, telling +Configuration file updated. Click OK to +make it disappear. + +This done, &kdevelop; will be ready to parse the documentation it knows of +and build some useful search indexes from it. Press the Update +Index button to the right. Now the Generating Search +Index dialog will pop up showing the progress of the index build +operations. + + + + + + +&kdevelop; is generating documentation search +indexes. + + + +This will take some time depending on the size of documentation and the +speed of your machine. But finally the Cancel will make +place to OK. Just press this button to proceed. + + + + +This usually should work out of the box. In some cases the +htdig application &kdevelop; uses to perform its full +text searches might not be properly set up. Refer to the Setting Up Text Search Indexes chapter +for more help in this case. + + +To be able to look up &kde; and &Qt; specific API documentation, it is +mandatory that the KDELibs Apidocs were present when +&kdevelop; was installed. If you experience problems building the indexes or +perform the identifier lookup +examples later in this chapter, make sure that this documentation exists +and is accessible to &kdevelop;. See Installing +KDevelop fore more detail. + + + + + + + + +Starting a New Project + +Almost any application will consist of dozens, hundreds, even thousands of +files which need kept structured and maintainable. To accomplish this, +&kdevelop; organizes software development tasks in +projects. Thus the first practical step to develop software +in &kdevelop; usually is to create a new project. + +Fortunately this is fairly easily accomplished. &kdevelop; provides the +so-called &appwizard; tool for this. (See the Getting Started — the &appwizard; +chapter for more.) + +We will now start a simple &kde; application project to illustrate how +easily this is accomplished and which files and tools &kdevelop; will have +provided. Thereby we will have a short look at: + + +How to create a new project +with the help of the &appwizard;. +Which files the &appwizard; +initially did set up. +What about the additional +tool view shown with the project? + + + +How to Create a New Project + +Let us create a rather simple Hello World &kde; project. +Just follow these steps. + + + +To start the &appwizard; click the Project +New Project... menu. + + + +The Create New Project dialog will pop up. In the +upper left All Projects window there will be a number of +programming languages listed. + + + +We want to build a &kde; C++ application as usual, thus click on the ++ label left of the C++ label to open +this branch. + + + +A series of possible application targets will be displayed. We will build +a &kde; application, thus open the next sub-branch via the ++ label next to KDE + + + +Now you will be offered a series of possible project +templates. Navigate down to the end of this branch and click +Simple KDE Application. + +A preview and short description of the application this project template +will produce pops up in the two windows to the right. + + + + + + + +Selecting a Hello World project template + + + + + +Our application will need a name. Find the Properties +area on the dialog bottom and enter a suitable name into the +Application name input field. + +We use Hello in our example, but you can use whatever you +like, provided the name consists of letters, number digits, and underlines only. +You will find that the &appwizard; rejects any other character. + + + +Make sure the Location text box below the input field +shows the name of your top project directory as set up in the A Bit of Configuration chapter above. +If it does not do so, enter a suitable directory name or select one from the +directory list provided by the folder labeled button to the right. + +If all went well, the Final location line at the +bottom will show the directory path your new project will use. In case there was +an (invalid) suffix appended, try another name for your project +and/or make sure the top project directory in the Location +text box really exists and is writable. + + + +Once everything is right, the Next button in the +bottom row of the dialog will be enabled. Click it to proceed. + + + + + +This will lead you to the Project Options dialog +page. Make sure the Author and Email +text boxes are properly filled in. Usually they will default to your general +&kde; user settings as given in the Password & User +Account dialog of the &kde; Control Center. If not, change them to +some settings you prefer for your application. + + + + + + + +Provide your name and (optionally) email address. + + + + + +You must provide an Author name at least. This is +mandatory for the application files setup. + + +If all is right, the Next button will be enabled. +Click it to further proceed. + + + +The following Version Control System, +Template for .h Files, and Template for .cpp +Files dialog pages are not of interest for now. Skip them by clicking +the Next buttons and, finally, the +Finish button. + + + +That was all! +The &appwizard; will take over and construct a series of initial files in the +Final location directory you provided in step 2c +above. + +Once this file creation phase is finished, &kdevelop; will open an editor +window for the application main window implementation file +(which is hello.cpp in our example), so you can readily +proceed. + + + +Initial Project Files + +Even if our sample Hello project is fairly simple, the &appwizard; did +create a whole bunch of source and project management files. You will most +easily list them if you open the File Tree tool view on the +bottom left. This will open a file list similar to the one below. + + + + + + + +Initial files in our Hello World project + + + + +To demonstrate the main bunch of files the &appwizard; produced, we did +open most of the directory branches in the left-hand File +Tree tool view window. Just click the branch names in the tree to see +for yourself. + +Additionally, just for demonstration, we did as well open most of the +branches the Automake Manager tool view window to the right +where some of the project sources are listed, too. + + +Copyright Issues + +All &GNU; conformant applications must be copyrighted. There are two +levels which require copyright notices, individual source +files and run-time application level. The +&appwizard; did already put appropriate copyright and licensing information into +the project files. + + +Source File Level Copyrights +Do you remember the +Project Options dialog page in the new project +setup? You had to provide your (the developer's) name and optionally an +email address there. Now refer to the top of the hello.cpp +editor window currently displayed in the workspace area. The &appwizard; did +enter these statements on top of the licensing header of every source file it +created. + + + +/*************************************************************************** + * Copyright (C) 2006 by Joe User * + * joe@user.com * + * * + * This program is free software; you can redistribute it and/or modify * + + +You will find exactly the same text headers in every source file you will +create inside &kdevelop; (provided you use the proper built in tools for file +creation). &kdevelop; remembers these settings in some template files you may +find in the templates directory. + + +Application Run-Time Copyrights +Once your &kde; application runs, the user may display some +About data, usually from the Help menu. +The &appwizard; did also take care of this. If you have a look at the +main.cpp file, you will find an entry similar to the one +below. + + + +int main(int argc, char **argv) +{ + KAboutData about("hello", I18N_NOOP("Hello"), version, description, + KAboutData::License_GPL, "(C) 2006 Joe User", 0, 0, + "joe@user.com"); + about.addAuthor( "Joe User", 0, "joe@user.com" ); + + +This will put the main developer's name (Joe User in +our case) and email address into the About copyright page +in the display and list this name and address on the +Authors page there as well. + + +Whenever you make substantial changes to an existing project, be sure to +enter your name and email address to the copyright notices on every file you +changed and to the run-time copyright display as well. Don't be shy, you +help the open source society considerably if you do so. + + + + +Initial Source Files + +The &appwizard; did put the source files into the src sub-directory of the project's directory. +You will find the main.cpp, hello.h, +and hello.cpp files there as you may have possibly +expected. + +There are some additional files you usually will find in a typical &kde; +application, namely + + + +hello.desktop contains some meta data used by +&kdevelop; to maintain and start the application. + + + +hi16-app-hello.png, and +hi32-app-hello.png contain some initial default icons, +&kdevelop; will use for application display. + + + +Finally, helloui.rc contains a description of the +application's user interface, currently the menus the application will +provide. + + + + + +Initial Application Documentation + +In the doc/en subdirectory of the +project you will find the index.docbook file. This is a +default template from where you can start to write a suitable user +documentation. + + + +Project and Auxiliary Files + +You will have noted that the files we introduced so far are listed in +boldface in the File Tree tool view while most of the other +files are not. This depicts the substantially different tasks these files are +used for. The contents of those bold listed files directly influence the +application. Source files will produce the code to be run, others will provide +necessary data or documentation. These files must be maintained and orderly +processed in the build stages by the project, hence they are called +project files. + +If you have a look at the lower Automake Manager +window to the right of the workspace area you will find all project files listed +as well. The &automanag; tool uses this knowledge to take care of the build +control as we shortly will see. + +The other, non-bold listed files are of more auxiliary nature. They belong +to several distinctive classes as follows: + + + + +Project Build Control +These files control the compile, install, documentation building, &etc; +processes. If the project utilizes the &GNU; +autotools machinery as our example does, you will +find a Makefile.am file in each project directory. These +are kind of basic make core files which contain build control commands and will +be processed in conjunction with various configure files +during the build stages. Such a build produces a final +Makefile in every directory. And from these in turn the +make utility will finally build the binaries of the +application. + + +Those Makefile.am files need to be maintained +throughout the development process. Luckily, &kdevelop; relieves you of most of +this burden by the &automanag; tool, which basically is a graphical front end to +maintain Makefile.am contents. + +Other project build control files currently listed are +configure.in.in and subdirs in the +project root directory. They will be processed by some of the files in the +admin &kde; specific administration +directory to produce more configure and +Makefile type files and finally the application's +binaries. + + + + +&kdevelop; Control Files +&kdevelop; needs some control and administration data on its own. These +are located in the project root directory, in our example +hello.kdevelop, hello.kdevelop.pcs, +and hello.kdevses. + + +Of particular importance in each project is the +xxx.kdevelop (where xxx denotes the project +name) file. It is the main KDevelop 3 Project File and +needed if you later want load this project into the &IDE;. + + +Never do manually modify, rename, or even delete any of these &kdevelop; +control files! The &IDE; will most likely not function properly on your project +afterwards. + + + + + +GNU Project Description Files +Some files in the project root directory are mandatory in any &GNU; +conformant application. These are: AUTHORS, +ChangeLog, INSTALL, +COPYING (which contains the GNU GENERAL PUBLIC LICENSE), +INSTALL, NEWS, +README, and TODO. + + + + + +Other Files +A few more files, not mentioned yet, are: + + + + +Doxyfile controls the creation of the project +specific &API; internal programming interface documentation. + + + +The templates directory containes +file templates the &IDE; uses as stubs to create new source files. +You may at any time edit these templates. The new contents will be reflected in +the next source files you create of the related types. + +You may ⪚ want to realign the right hand stars in the copyright lines +the &appwizard; inserted into the cpp and +h template files, so the source files created from them +will look less awkward. + + + +The po directory will be used for +localization purposes. It is essentially part of the project files (contains a +Makefile.am) but will mainly be used in translation +processing. Not of main interest to the application developer, however. + + + +Finally, the admin directory is +specially needed in &kde; oriented applications. It provides a whole bunch of +files necessary to maintain the application's sources and binaries so they +will integrate properly into the &kde; environment. + + + + + + + + + +Additional Tool Views + +As you will have noticed, as soon as the &appwizard; had the new project +ready, several additional tool views were provided. These make sense during +project development only and, in short, provide the following +functionality. + + +The tool views actually visible depend on the plugins currently loaded +into &kdevelop;. There are ways to control this. See the Plugin Tools chapter for instructions. + + + +Navigation and Selection Tools (left side) + + + + +Bookmarks +You can mark any text file line in order to quickly return to this +position from everywhere. &kdevelop; will remember all those +bookmarks, even if you close the editor window afterwards. +The Bookmarks tool view lists all those bookmarks by file +name and line number. You need only click such an entry to open the editor +window accordingly and position the cursor on that line. + + + + + +Classes +Lists classes, methods, &etc; known in the project. Clicking the entry +opens the appropriate header or source file in an editor window and positions +the cursor at the respective declaration or definition. + + + + + +File Groups +Sorts the files in the projects into various utility groups, &ie; Sources, +User Interface, Icons, Translations, and Others. Clicking an entry opens that +file in an editor window. + + + + + +Variables +This is used by the debugger tool to display, evaluate, and watch +variables during debug runs. + + + + + + +Messages (bottom) + + + + +Valgrind +Valgrind is a run-time program analyzer. This +tool view lists the results of such an analyze run. It is used ⪚ to find +memory leaks. + + + + + +Security Problems +There is a Security Checker plugin tool for +&kdevelop;. It analyzes the currently edited source file for several common +security problems which may occur in the application and notifies the user in +this tool view window. + + + + + +Breakpoints +This tool view allows to explicitly set, clear, and manage debug +breakpoints in the application source files. It is used in conjunction with the +debugger. + + + + + +CTags +Allows to create a database of identifier indexes using the popular +CTags application. This tags database may then be +used from out this tool view window to look up any needed identifier in the +project sources. Clicking a thus found item line will open an editor window and +position the cursor on the appropriate identifier there. + + + + + +Problems +&kdevelop; keeps track of common programming problems in the currently +edited source file and notifies the user in this tool view window. + + + + + + +Source Management (right side) + + + + +Automake Manager +The &automanag; tool is basically a graphical front end to maintain the +contents of the Makefile.am files located in each project +directory. This tool view uses two windows to control its work. The upper window +mirrors part of the project subdirectories, namely those which explicitly +contain project files. Each subdirectory of this kind must +contain a Makefile.am file and is termed a +subproject in the &automanag; context. + + +Clicking a subproject entry opens a suitable display of the project files +in this subproject in the lower window. The files listed there will be grouped +according to their Makefile.am functionality in this +subproject. + +The &automanag; is a very powerful tool to manage the project and its +subprojects as well as the roles project files play in building the application. +We will have a short look at a few major details below. See the Building and Project Management chapter for +a more extensive description. + + + + + + + + +Some Tips About Dealing With Documents + +In our example project the &appwizard; did leave the +hello.cpp file open in an editor window, so you can +immediately start working. Now, we may well assume your are knowledgeable about +using an editor, so we do not need talk much about this here. But there are some +handy &kdevelop; specifics about dealing with such tabbed editor windows and the +documents you are working on. We will have a short look at some of them, +namely: + + +How to easily switch between +header and implementation files. +How to quickly access +declarations and definitions. +How to arrange editor +windows to your current needs. +How to keep an eye on +common problems. + + + +Switching Between Header and Implementation Files + +&kdevelop; provides a quick and easy way to switch from a given +implementation (.cpp) file to the corresponding header +(.h) file and vice versa. Just right click into the editor +window you want to switch. A menu similar to the following will pop up. + + + + + + +How to switch between implementation and header +files. + + + +Find the Switch header/implementation entry and +select it. &kdevelop; will look up the corresponding header or implementation +file and open it in another editor window. In our example, if you did right +click into the hello.cpp source, the +hello.h file will be displayed and the cursor positioned +there. + +There is even more. If you do right click inside the text of a class +implementation, &kdevelop; will position the cursor on the corresponding +declaration line in the header file. And vice versa, right clicking on a +declaration line will bring you to the corresponding class +implementation. + +If the editor window with the file to be switched to already exists, +&kdevelop; will of course activate this one and reposition the cursor there if +necessary. + + + +How to Access Declarations and Definitions + +But what if you are working on a source file and want to look up the +declaration or definition of an identifier you just found there? Well, this is +equally easily accomplished. Basically all you need to do is to right click on +the identifier in question. + +There are two different cases to consider, however, namely: + +Accessing externally +defined identifiers, and +dealing with project +internal text items. + + + +External Declarations and Definitions + +In a most common case you want to look up an identifier which was defined +externally to your project. In &kde; projects such identifiers are most likely +documented in various &kde; or &Qt; libraries. If &kde; and &kdevelop; were +properly installed, &kdevelop; will be able to access such so-called API +documentation and be able to search it for identifiers of this kind. + +Let us look at an example. In the hello.cpp editor +window find the following lines. + + +Hello::Hello() + : KMainWindow( 0, "Hello" ) +{ + + +Right click on KMainWindow. +A menu will pop up. There select the Search in Documentation: +KMainWindow entry and release the mouse button. Now the +Documentation tool view will open, showing the +KMainWindow entry as search item on the +Search sub-page. And a short while after another editor +window will open in the workspace area, showing the KDE API Reference page of +the KMainWindow class. + +This all will look like the following. (We deliberately opened the +Documentation, Search page already to +illustrate the result of the menu selection.) + + + + + + +How to look up an externally documented +identifier. + + + +You might as well select Find Documentation: +KMainWindow. In this case the Finder sub-page +of the Documentation tool view will show up, usually +providing a selection of pages containing the search term. (In our example this +will probably be the KMainWindow and +KMainWindowInterface classes. Select the one you are +interested in and the corresponding documentation will be displayed in an editor +window. + + +If this did not work, then there is probably no documents index yet. Did +you initialize the indexes as shown above? If not, please do so, +then come back here and try again. + + + + +Project Internal Declarations and Definitions + +Such search facilities in external documentation have their limitations, +however. Of course one cannot look up an identifier externally if it is only +defined and used inside the current project. But there is help. &kdevelop; can +use indexes built by the CTags application to search +the sources in your project. + +Before we can use this on our Hello example project, we must however first +generate a suitable index. This is done by the CTags tool +view at the bottom of the workspace area. + +When you click the CTags tab, a dialog window will +open where you will find the following key in the lower right corner. + + + + + + +Build a CTags index with the Regenerate +key. + + + +Press the Regenerate button and wait a few seconds. +Then the No CTags Database Found will be replaced by the +current date. Now you are ready to perform some identifier look ups in your +project source. + + +The date next to the Regenerate button is there to +remind you of possibly too old indexes. Whenever you are obviously not able to +look up some identifier in your project, consider regenerating the index. On +large projects this might take considerable time, but you should make it a habit +to regenerate the index regularly after extensive source file changes. + + +To look up an identifier in your project sources there are several +possibilities. + + + + +Use the CTags tool view +This is easy. +Just start typing the identifier name you are interested in into the +Lookup input field in the bottom left. &kdevelop; will try +to complete the word you have typed so far and show all occurrences of those +identifiers which start with this character sequence. + + +If for example you want to know wherever the Hello +identifier was used in our example project, type an "H" into the +Lookup input field. &kdevelop; will immediately start +working and present you a result like this: + + + + + + +How to look up an identifier in the CTags +tool view. + + + +If you click one of the listed entries, &kdevelop; will open an editor +window with this file and position the cursor on the appropriate place. + + + + +Use a context menu in a source file +This is handy while you are working on a certain source file. +Assume you are studying the main.cpp file of our Hello +example project. There you find the following line + + + Hello *mainWin = 0; + +and wonder whatever the Hello was used for in the program. +To find out, simply right click on this Hello identifier. A menu will pop up in +response to this right mouse click, featuring the following lines near the +bottom. + + + + + + +Getting CTags information on a project +internal identifier. + + + +Click what you are interested in, say CTags - Go to Definition: +Hello, and &kdevelop; will immediately open the +hello.cpp editor window and position the cursor right in +front of this class definition: + +Hello::Hello() + : KMainWindow( 0, "Hello" ) +{ + + + + + +Do a global search +This is especially useful if you want to look up arbitrary text in your +project source. There are two possibilities to start a global search from within +&kdevelop;. + + + +Start a global search from the Edit +Find in Files... menu. +Or + + +Directly make use of the context menu with a right mouse click in the +editor window. + + + +We will illustrate the second possibility on our Hello example project. +The outcome of the menu call will essentially be the same. Let us assume you are +studying the hello.cpp source file and have the cursor +positioned on the first Hello occurrence there. Now you wonder, where this one +word Hello was used in the project source and how many +occurrences there are. This is a typical case where to use &kdevelop;'s +global search facilities. + +Now, still keeping the cursor somewhere on this Hello in +the source text, click the right mouse button. The now well known context menu +will pop up, where you should select the Grep: Hello +line. + + + + + + +Initiating a global search from within an editor +window. + + + +This will pop up the following Find in Files dialog +(exactly the same as if you did use the Edit +Find in Files... menu). + + + + + + +A versatile graphical front end to perform global searches in the +project. + + + +As you see, this is a very versatile tool to initiate +find-and-grep searches +throughout your project. We won't delve further into details here, but you +may want to experiment with this facility on your own. For the moment, there +should be our Hello be preselected in the +Pattern field. If it is not, just type it in, then press +the Search button at the bottom right. + +Now the Find in Files tool view will open at the +bottom, showing you file names and lines of all literal occurrences of +Hello in our example project. As usual, if you click an entry, +&kdevelop; will get you to exactly that position in an editor window in the +workspace area. + +There are two lines of special interest in the tool view window. + + +Right on top you will find the command sequences &kdevelop; did actually +use to perform the search. This will be useful to more precisely control the +search outcome. + + + +On bottom the number of occurrences found in these search run will be +listed. In our example this should read *** 11 matches found +***. + + + +&kdevelop; will remember these search results throughout the currently +running session. If you initiate another global search, its results will display +in another tabbed window in the Find in Files tool view +window. + + + + + + +Arranging Editor Windows + +When your work with large complex projects you will often end up with +quite a lot of tabbed editor windows residing on the tab bar. This makes +specific facilities to clean up, order, and group all those editor tabs +necessary. &kdevelop; provides several means for this. We will have a short look +at some of them. + +How to remove unneeded +tabs. +How to rearrange the +tabs. +How to view several +files simultaneously in the workspace area. +How to edit +C++ source and header files simultaneously +How to group source +files into development sessions. + + + +Cleaning up the Tabs Row + +If the vast amount of editor window tabs becomes badly arranged at all, +you usually may want to close all those tabs you really do not need any more. +&kdevelop; provides several facilities to do so, the usual way of bulk closing +open editor windows and a more specific approach where you can expressly command +which ones to close and which to keep open. + + +Closing Several Tabs At Once +This is kind of a bulk approach to close unnecessarily open tabs which you +may find in other &kde; applications as well. You can use the +Window menu or right click on a tab to either + + + +close the currently selected editor window, + + +close all other open editor windows, or + + +close all editor windows at once (available from the +Window menu only). + + + + +Closing Selected Sets of Tabs +The step-by-step approach of closing individual editor window tabs can +become awkward if there are a great number of tabs from which you want to still +keep several open. Instead of searching and closing one editor window tab after +another &kdevelop; provides a means to select the candidates from a list and +close those, and only those, with one single mouse click. + + +Let us illustrate this on a simple example. +In our Hello example project let us assume there were several files open for +edit: hello.cpp, hello.h, +helloui.rc, hello.desktop, and +main.cpp. Now you want to close all of them except +hello.cpp and hello.h. The easiest way +to do so is with the File List tool view. Because this list +of open files is alphabetically ordered you can more easily find the ones you +want to be closed. Proceed as follows: + + + +Open File List and, with the Ctrl +key held down, click the files you want to be closed in the list. + + +Then, keeping the mouse pointer on a file name in the list, click the +right mouse button. + + +From the File List popup menu select Close +Selected. + + + + + + + + +How to close selected editor windows in one +step. + + +That was all. +&kdevelop; will have closed all editor windows at your wish, and you are ready +to proceed with a clean tab bar again. + + + +How to Rearrange Edit Window Tabs + +Even if you have only the really necessary editor windows open you may +still want to have their tabs arranged in some logical way. &kdevelop; provides +some common means to do so, in short: + + +Basic Setup — Where to Position New Tabs + +By default, when you open a new editor window, its tab will be inserted to +the right of the editor window tab currently in use. This can be changed so that +the new tab will open to the far right on the tab bar. + +You must change a basic user interface setting in &kdevelop; to enable +this behavior. + + +Select Settings Configure +KDevelop... + + +In the left hand icon bar on the dialog popup click the User +Interface icon. The User Interface dialog page +will be now shown. + + +In the left bottom corner there find the section labeled Tabbed +Browsing. Remove the check mark on the Open new tab after +current tab line. + + +Close &kdevelop; and restart it again. Now the new editor window tabs will +open at the far right end of the current tabs row. + + + +Unfortunately, this setting cannot be changed on the fly during a +development session. You must make up your mind which behavior you prefer in the +long run and then stick to it, at least until the next start of +&kdevelop;. + + +How to Rearrange the Tabs +As development tasks do vary over time, the need to rearrange the tabbed +editor windows will more or less often arise. This is easily accomplished in +&kdevelop;. + + +Just click the tab you want to move with the middle mouse button and move the +mouse a short distance. The cursor will change to a crossed-arrow pattern. You +can now drag this tab, holding the middle mouse button down, until it did skip +into the place where you want it to be. + + + +Viewing Several Files Simultaneously + +At first sight there is always at most one single editor window open to +work on a source file. Although you may fast switch the tabbed windows, there +are times where you want have several files open at once, ⪚ for reference +purposes or to keep complex tasks under better control. To accomplish this, +&kdevelop; provides a way to split the workspace area into different, +simultaneously visible sections which each can hold their own series of tabbed +windows. + +There are two split commands which you can reach either through the +Window menu or by right clicking either into a tabbed window +or on the window tab itself. We will illustrate this splitting behavior again +with our Hello example project. + +Assume there are two source files open on the tab bar, +hello.cpp and hello.h. Now, while +working on the hello.cpp source, you often need to refer to +the declarations in the hello.h headers file, so you want +to keep both files open simultaneously. + +To get this done, right click on the tab of, say, +hello.h. The following menu will then pop up. + + + + + + +How to split the current workspace area into two +parts. + + + +Select the Split Horizontal entry. This will +split the current workspace area in the middle and move the tabbed editor window +holding the hello.h file into the lower part. + + + + + + +The workspace has been split horizontally. + + + +Note the dotted separator line between both windows. You can grab it with +the mouse and adjust the heights of the editor windows according to your +needs. + +There are a few points to note. + + +The split workspace areas are fully functional at their own. This means, +new tabbed windows will open in the workspace which contains the currently +active editor window. And you can split any sub-area again to your wish, thus +keeping as much windows open simultaneously as you need. + + + +Any split will move the currently active editor window into the new +workspace sub-area, either downward or to the right. The other tabbed windows +all remain where they were. You cannot directly move tabbed windows between +split areas, instead you need to explicitly close the window in one workspace +area and reopen it in another to regroup. + + + +Also, there is no direct way to close a split area again. +It closes automatically, once the last tabbed window in it was closed. + + + + + +Edit C++ Source and Header Files Simultaneously + +There is a neat application of the above mentioned workspace split +feature built into &kdevelop;. It allows to automatically keep a +.cpp source and its accompanying +.h header file side by side open in the workspace area. +And, optionally, it allows to work on both files synchronously, such that if +you select a declaration in the header file &kdevelop; will navigate to the +respective definition in the source file and vice versa. + +This feature is however deactivated by default. If you want to use it in +your project you need to activate it. + +Select Project +Project Options. The +Project Options dialog will pop up. In the left hand icon +bar there select C++ Support and subsequently the +Navigation tab on the dialog page which will display on +the right side. + + + + + + +Have C++ source and header files be displayed side by +side. + + + +Now check the Enable split of Header/Source files +box. This will enable Automatic Synchronize +and Vertical by default. Keep these settings for now and +press OK. + +To illustrate this feature, now close in our example Hello project +both the hello.cpp and hello.h editor +windows, if necessary. Then select hello.cpp again from the +src subdirectory of the project. The +editor window will open as usual. But if you now open the +hello.h belonging to it, &kdevelop; will automatically +split the workspace and open this header file editor window just beneath the +hello.cpp window. + +There is even more, as we mentioned already. In the +hello.cpp editor find ⪚ this constructor definition +line: + +Hello::Hello() + +and put the cursor there. Then look at the hello.h +window below and note how &kdevelop; did navigate to the corresponding default +constructor declaration line. + + + + + + +&kdevelop; automatically navigated to the constructor +declaration. + + + +This works vice versa as well. Whenever you put the cursor somewhere into +a construct in one editor window, &kdevelop; will navigate to the corresponding +construct in the other. + + + +Grouping Source Files Into Development Sessions + +When your project grows larger, and the development tasks become more and +more complex and force you to often switch between different, even distinct sets +of files, it is about time to organize your development work into distinct +sessions. The File List tool view of &kdevelop; allows you +do to just this. + +On top of the File List tool view window there is a +tool bar where you can create, save, select, and remove such sessions. Or +alternatively use the View View +Sessions sub-menu. + +We will illustrate this facility again with our Hello example project. +Assume you want to always open the hello.cpp, +hello.h, and main.cpp files all in one +step, no matter what development task you just did perform in the project. To +accomplish this, you first need to create a new development session named, say, +sources. + + + + + + +Use development sessions to remember groups of +files. + + + +This is a multiple step approach as follows. + + +Create a new session + + +Click the New Session icon top left in the +File List tool view window. + + +A dialog will pop up. In the Enter the name of the +session input field give your new session a name, ⪚ +sources. + + +Close the dialog with OK. The new session will now +be listed in the drop down box on the toolbar. + + + + +This new session will initially be empty. You must populate it with the +files you want to be kept there. + + +Open all files you want to be grouped in this development session. In our +example we decided to keep hello.cpp, +hello.h, and main.cpp there as +planned. + + +Once your file list is complete, click the Save Session +icon in the toolbar. Do not skip this step, &kdevelop; will forget the file list +otherwise. + + + + + +That was it. Whenever you select the sources session +from the Open Session drop down box, &kdevelop; will close +all currently open editor windows and open the remembered ones +(hello.cpp, hello.h, and +main.cpp in our example) instead. + +You can define as many sessions as you wish in the context of your +project. If you want to change the session's contents, just update the +remembered file list with a Save Session click. And if you +want get rid of a session, select it in the drop down box, then click the +Delete Session icon in the toolbar right. + +There is even more. You can force &kdevelop; to open a given session by +default when it loads the project. Just select the session in the drop down box +on the Projects Project +Options File List project +options configuration page. + + + + + + +Let &kdevelop; open a specific session when the project is +loaded. + + + + + + +Keeping an Eye on Common Problems + +When you open an editor window containing a source file, &kdevelop; will +parse its contents. This allows the built in problem +reporter to scan the source text for some common errors it knows of. +And it can alert the user of different places which have been marked for special +treatment. + +Let us illustrate this facility with our Hello example project. + + + +Open an editor window with the main.cpp source +file. + + + +Make sure it still contains the following line somewhere towards the +end: + + /// @todo do something with the command line args here + +This was inserted by the &appwizard; when you created the Hello project in +the Starting a New Project chapter +above. + + + +Now open the Problems tool view in the bottom tabs +row. If all went right, it will currently report this todo: + + + + + +&kdevelop; is alerting a source code line containing a todo +mark. + + + + + +The format of the /// @todo command is +for special treatment by the Doxygen code documenter, +which we will look at briefly in the Documentation section below. It is not +mandatory that you use this format, the more common +TODO and FIXME +comment marks will be recognized as well. + +If you ⪚ insert the following TODO and +FIXME comment lines in our +hello.cpp example file + +Hello::Hello() + : KMainWindow( 0, "Hello" ) +{ + // set the shell's ui resource file + // TODO check the user interface + setXMLFile("helloui.rc"); + + // FIXME change to a better suited greeting + new QLabel( "Hello World", this, "hello label" ); +} + +you will find them listed in the Problems tool view +as well: + + + + + + +The problem reporter listing lines which require attention in the +currently edited file. + + + +Note the other tabs in the Problem reporter tool view +window, especially Fixme, and Todo. If +you open them, you will find all FIXME and +TODO marked lines, &kdevelop; has found so far +in this session. For example the TODO alerts +will currently look thus: + + + + + + +The problem reporter has collected the +TODO alerts. + + + +The Errors tab will however not list every coding +error you make. This is the job of other tools in ⪚ the build process. But +you will find here alerts of some common programming mistakes which would likely +go unnoticed otherwise and probably be catched with difficulties during complex +debugging session. + +You will find the &kdevelop; problem reporter facility a very valuable +tool, so check the Problems tool view regularly in the +development process. + + + + +How to Compile a Project + +Compiling a project in &kdevelop; requires several setup steps and then +building the application. All these are available through the +Build menu. + + + + + + +Building a project requires several steps. + + + +We are interested for now in the upper section only of this menu. The +entries there are sorted in order of their importance. Thus the most often +needed command is on top, the Build Project entry, +which will cause all of the project be initialized, compiled and linked as +needed. Other entries are there to compile selected project portions or a single +file only, to perform several initialization sequences, or to install the +completed application binaries. + +For now we will concentrate on several facilities which &kdevelop; +provides for project setup, initializing, building, and running an application. +In general, this includes: + + +Looking briefly at the +basic build cycle. +Looking at some basic +means to configure a project. + + + +The Basic Build Cycle + +Once you created a new project you usually want to check if everything +went right so far. This implies a first build and test run of the application, +which we will do now. In order to initially compile a project there are several +steps to perform, which we will briefly look at. + +How to initialize the +project for a first build. +How to do the +initial configuration. +How to build the +project. +How to run the +application from within &kdevelop;. + + + +This discussion implies that your project is based on the &GNU; autotools, +which enabled the &automanag; tool in &kdevelop; as our example Hello project +does. If you created another type project, ⪚ for the &Qt; based +QMake project manager, there will be other facilities +available in the menus or perhaps even none of them. You will have to consult +the respective vendor documentation on project management and application +building in these cases. + + + +Initialize the Project for the Build + +When the &appwizard; created our Hello example project, it left it in a +sort of raw, virgin state. The &GNU; autotools chain dictates +several initialization steps to be performed before the application could be +actually compiled and linked. If you try to build a project in such a raw state, +⪚ by selecting the Build Build +Project menu or pressing the F8 +function key, you will get the following warning. + + + + + + +Trying to build a raw automake based project. + + + +You may press the Run Them button in which case +&kdevelop; will try to automatically run all required setup steps prior to +compiling and linking the application. But we will look at those initial steps +in sequence, so cancel the dialog by pressing Do Not run. + + +As mentioned already, compiling and linking the application is done +through the Build menu. Call it up and select +Run automake and friends. + + + + + + +Initiating a basic initialization run. + + + + +&kdevelop; will now open the Messages tool view window at +the bottom and list a series of messages produced by several make tools. If +everything went right, the final line will read +*** Success ***. + +If you scroll back to the top, you will find the command line, &kdevelop; +issued to call up the tools beneath the surface: + + +cd '/home/devel/projects/hello' && \ +WANT_AUTOCONF_2_5="1" WANT_AUTOMAKE_1_6="1" gmake -f Makefile.cvs + + +This basically tells that &kdevelop; first switched to the root directory +of our example project. Then it set up a dedicated environment, advising the +make system of the autoconf and +automake tool revisions used for this initialization. +And finally it instructed the make tool (&GNU; gmake +in this case) to process the Makefile.cvs make file. + +This make file was automatically set up when you created the Hello +project. It contains all the commands necessary to properly initialize the +project so the resulting application will run under &kde;. Especially this will +create the configure skript file necessary to perform the +next setup step. + + + +Initial Hello Configuration + +Configuring means to tailor the build process to the hardware and software +peculiarities of your system. This is a basic requirement in build processes +based on the &GNU; autotools scheme as you probably will know. + +You can command a configure sequence once the basic automake +initialization has been successfully finished because only after this +initial run the necessary configure files will be +available. This done, select the Build +Run Configure menu entry to initiate a +configuration sequence. + +&kdevelop; opened the Messages tool view +window again if necessary and listed the messages of the configure run therein. +If all went right, the final messages will be Good - your +configure finished. Start make now (which was issued by +configure) followed by the &kdevelop; *** Success +*** message. + +On top of the +Messages window you will again find +the command line, &kdevelop; used to initiate this configuration run: + + +mkdir '/home/devel/projects/hello/debug' && \ +cd '/home/devel/projects/hello/debug' && \ +CXXFLAGS="-O0 -g3" "/home/devel/projects/hello/configure" --enable-debug=full + + +You can tell several interesting details from these commands. + + + + + + + + + + + + + +First, &kdevelop; uses a dedicated subdirectory in the project directory +tree for the build process. This debug +build directory (shown to the left) mirrors the basic project structure and +contains some set of build related files, such as several +configure based files and additionally a +Makefile in each subdirectory. + + +In the Configuring the +Project +section shortly below we will have a brief look at the motivations why +&kdevelop; uses separate build directories in cases like this one. For the +moment it is enough to know that &kdevelop; created this debug directory — if necessary — prior +to the configure call and that the configure script did +build the sub structure and all the Makefiles in +there. + + +Next, from within the debug build +directory, &kdevelop; called the configure script in the +root directory of our project using a dedicated environment, where the +CXXFLAGS="-O0 -g3" flags will later signal the +&gcc; compiler that it should not optimize the resulting binaries and include +full debugging information with them. + + +Finally the configure script was called with the +--enable-debug=full option which instructs it +to create each Makefile so that later compilation and +linking will have all necessary debugging information be built in and +usable. + + + + + + +All these settings are configurable on a per project basis. You will learn +more about this in the Project +Management chapter. + + + +Build the Project + +Once you got this far you will be ready to actually build, &ie; +compile and link the application. Looking at the Build menu, +there are three such compile options from which to select. + + + + + + +&kdevelop; commands to build binaries. + + + +Going from bottom to top, there are: + + +Compile File — This will compile the +source file in the currently open editor window. Mostly used for quick error +checks. + + +Build Active Target — This is mainly used +in conjunction with the Automake +Manager which we will briefly look at below. + + +Build Project — Now this is what we +currently are interested in. It will iterate over the whole project, compiling +and linking all files as necessary. + + + +It might be interesting to watch what happens to the +Debug directory created in the former +configure run. So best keep it open with all +subdirectories unfolded just as shown above. Then select +Build Build +Project (or press the F8 key) to +initiate the build sequence. As before, the Messages tool +view window will open at the bottom and list the outcome of this build run. And +additionally some files will appear on the Debug subtree. + +There are not many source +files in our Hello example project, so the Messages window +will contain only a few lines. On top of them again find the command line +&kdevelop; issued to the underlying shell. + + +cd '/home/devel/projects/hello/debug' && \ +WANT_AUTOCONF_2_5="1" WANT_AUTOMAKE_1_6="1" gmake -k + + +Not very surprisingly, &kdevelop; switched to the Debug subtree root in order to run the +Makefile located there. A dedicated sub-environment was +set up again as before in the Initialization step in which +then the gmake tool was called. + +Note the -k option in the +gmake call. It forces the build process to continue +up to its very end, even if errors will occur. This makes sense as &kdevelop; +will list all error messages in the Messages window. If +there are any, use the virtues of an &IDE;: Just click on the error message in +the Messages window and &kdevelop; will take you to +exactly the position where the error occurred in the source file. + +And what did happen inside the Debug subtree? Not very much. A few files showed up +on the doc/en and src branches, most notably the +hello file in /home/devel/projects/hello/debug/src/. This, +finally, is the application binary we were looking for. All what is left +to do in our initial project check is to run this +hello. + + + +Run the Application + +There are no extra steps involved to run this new Hello +application. Either select Build +Execute Program or press +Shift F9 or use the +Execute program button on the Build +Toolbar shown below. + + + + + + +Running an application form the Build +Toolbar. + + + + +That was all. &kdevelop; will now start the new application in +the dedicated console window which opens as Application +tool view on the bottom. There the command &kdevelop; issued to execute the +program will be shown in the top line: + + +./hello + + +showing that the &IDE; has a notion about where the executable it +shall run resides. This notion can be widely configured. See more about +this in the Project +Management chapter. + +The ./hello line will most likely +be followed by a warning message. Ignore this for now. It does not keep +our Hello form running. + + + + + + + +Our initial Hello application. + + + + +Close the Hello application window as +usual. If no errors occurred, &kdevelop; will report this as +*** Exited normally *** +in the Application tool view window. + + + + +Configuring the Project + +In &kdevelop; there are numerous ways how you can manage your project. +This behavior is configurable on a per-project basis and mostly of interest to +the advanced developer. Yet there are a few project specific settings you +should know of right from the beginning. + + + +Of what use are build +configurations? + +Where to the define +the behavior of the configure script. + +Some considerations +how make should run. + +Where should the +executable be and how should it be called? + + + +Build Configurations + +When we did a first run of the configure script in +the Initial Hello +Configuration section above, we noted that &kdevelop; had set up a +dedicated debug subdirectory for this +purpose. In this section we will briefly consider some consequences of +this feature. + +First of all, &kdevelop; does not necessarily use dedicated build +directories apart from the source. The preparations to automatically use +dedicated build configurations is done through templates the &appwizard; uses +when creating a new project. + +To find out which build configurations currently are available, have a +look at the Project Build +Configuration menu. + + + + + + +There are various build configurations available +for this project. + + + +In this case, like our Hello example project, there are three different +build configurations available. In other cases, there may — initially +— be only one such build configuration, namely +default. + +The currently used build configuration has a check mark left to it. In +order to switch to another build configuration simply select its menu +entry. + +Now let us have a brief look at what these build configurations +provide. + + + +debug + +You should use this as the standard build configuration during the +development process. The build occurs separately from the source directories in +the dedicated debug subdirectory, &ie; +all object, auxiliary, and executable files will be put in the subdirectories +there instead of their counterparts in the project root. The +configure script will be given the +--enable-debug=full option and the +CXXFLAGS="-O0 -g3" will signal the &gcc; +compiler to not optimize the code and to insert extensive debug information +into the resulting binaries. + + + + +optimized + +This is used to build a final C++ application. The build occurs +separately from the source directories in the dedicated optimized subdirectory. No specific arguments to +the configure script will be preset, yet the +CXXFLAGS="-O2 -g0" will signal the &gcc; +compiler to optimize the code and to not insert debug information into the +resulting binaries. + + + + +default + +The term default denotes the standard setup when you build +an application from the console using ⪚ the &GNU; +configure and +make/gmake command line +oriented build tools. Other than debug or +optimize no dedicated build directory will be used. +The application will by default be built in the sources directories instead. +There are no special configuration switches predefined. Building and running the +application will use the default settings of the underlying tools (e.g. &gcc;, +etc.). + + +Think twice before you decide to use the +default build environment! + +It cannot be used in parallel to the dedicated +debug or optimized ones. +Any build operation using default will +render both of the other build environments unusable. This is caused +by some peculiarities of the Makefile construction process +using the +automake/autoconf +machinery, which cannot be easily overcome. + + + + + +Now, why does one one want to use different build configurations at all, +when they even appear to be not compatible to each other? The answer is — +it simplifies edit-compile-debug cycles. The extra debug instructions +inserted into the binaries as well as all those subtle structure changes to +the program code made during optimizations will effect the run time behavior of +the resulting application. So in many cases, when the logical structure of some +routine appears to be correct, you may want to test whether it still behaves +correctly under more practical conditions. + +This is where the build configurations of &kdevelop; step in. Because +the built object and executable files in each dedicated build directory and the +build commands are kept separately from each other only source changes need +to be handled when you switch between these build configurations. + +Thus instead of cleaning up and recompile everything from scratch with +alternate options, you need only switch from the +debug to the optimize +build configuration, have the source changes compiled in and then retest the +application under these circumstances. If anything inappropriate shows up, +simply switch back to debug and immediately continue +your work there. + +A final note — many build configuration settings are configurable. +You can even define your own build configurations if your development process +requires some. We will briefly look at these possibilities in the next +section. + + + +Project Configure Options + +Configuring the application properly is vital in the &GNU; +autotools building chain. This is usually guided by option definitions to the +configure script and/or specific flags settings in the +environment prior to running configure as ⪚ the +CXXFLAGS in our previous discussions. + +You may set most of the configuring options for a given project from +within &kdevelop; &GUI;. Select +Project +Project Options and then from the +icon bar on the left of the dialog the Configure Options +icon. The Configure Options dialog featuring several tabbed +windows will display on the right handed side. + + + + + + +Most configure options can be defined here. + + + +As you see, there are quite a lot of options you can set up in this +dialog. For now we will briefly look at only a few of them with regard to our +Hello example project. For detailed instructions see the Configuring Projects chapter. If you +want to know more about the meaning of the various flags which can be +set, look up info make from the console (or +info:make from within &konqueror;) and there the +Implicit Rules +Implicit Variables section. + +There are several tabbed dialog setup windows from which the first +one, General, refers to commonly used settings, +while the others are rather compiler specific. In all cases, however, will the +actual contents of those dialogs be governed by the given build +configuration. + +You select the build configuration whose configuration settings +have to be defined from the Configuration combo box +on top of the Configure Options dialog. + + + + + + +Select the build configuration whose settings to +define. + + + +Now select another build configuration from this combo box and note how +the contents of ⪚ the Configure arguments and +Build directory text boxes change according to the +settings we mentioned in the build +configurations list above. + + +General Configuration Settings + +On the General dialog page, these +configuration options can be defined: + + + + +Configure arguments +These are the options &kdevelop; assigns to the +configure script call in the build process. See the +example in +the Initial Hello Configuration section above. + + + + + +Build directory +This is the subdirectory in the current project root, where &kdevelop; +will put all files created in the build process. Ideally, this should +correspond to the name of the build configuration in use, but you are +free to use any name you like, provided it is different from any other +build configuration directory. + + + + + +Top source directory +You won't need this one often. It defaults to the project root +directory and needs only be redefined if your project sources are located +in another place. + + + + + +C/C++ preprocessor flags (CPPFLAGS) +Put specific instructions for the preprocessor here. &kdevelop; will +use this to set up a temporary environment before it calls the actual +build tool. Again, see the example in +the Initial Hello Configuration section above how this is +done. + + + + + +Linker flags (LDFLAGS) +This is extra information for the ld linker +tool where it should look for additional libraries. It is used to build the +temporary build environment as well. + + + + + +Environment Variables +Here you may define additional variables to be set up in the +temporal build environment, &kdevelop; will set up before calling the +respective build tool. Again, you must define these environment variables for +every build configuration where they are to be used. + + + + + + +Compiler Specific Settings + +The other tabs on the Configure Options dialog +page are for compiler specific settings. They are similarly structured, +so it suffices to have a brief look at the C++ page. + + + + + + +Select the compiler and its working environment &kdevelop; shall +use here. + + + +This is what you can set up from here: + + + + +C++ compiler +Select the C++ compiler &kdevelop; should regularly use from this +combo box. It however lists only those compilers &kdevelop; really knows +of. + + + + + +Compiler command (CXX) +Only for experts. This is only needed if the C++ compiler is not standard. +Put the name by which it is called here. + + + + + +Compiler flags (CXXFLAGS) +Here you can enter any extra option &kdevelop; shall pass (via the +Makefile) to the compiler. Some option values will be +preset according to the build configuration selected in the +Configuration combo box. + + +Note, that many common compiler options can be selected from a +dialog which will pop up when you press the ... button to +the right of the text box. + + + + + + +Use this dialog to define the &GNU; C++ compiler +behavior. + + + +We deliberately selected the Optimization tab +here. Note how the No Optimization option has been +preselected (according to the -O0 +option preset in the debug build +configuration). + +Unfortunately you cannot currently select all options from this +dialog. The -g3 option ⪚ used by the +debug build +configuration would have to be altered manually if ever needed. + + + + + + +How Make Should Build the Program + +You can as well configure the way &kdevelop; will call the +make tool in the project build. Select +Project +Project Options and then the +Make Options icon from the left dialog window side. The +Make Options dialog page will then be displayed to +the right. + + + + + + +Define how &kdevelop; will call the +make tool. + + + +There is not much to do here for now. The only setting of interest in +most cases will be the Abort on first error switch. +You will find it deactivated in most projects. This corresponds to the +-k option in the +gmake call we found in the initial build of +our example Hello project. + +This makes sense in an &IDE; like &kdevelop; which will protocol any +error message during the build. After the build process you may easily +navigate to any error message in the Messages tool +window. Use View +Next Error and +View Previous +Error or respectively the F4 and +Shift F4 keys for this. +&kdevelop; will automatically activate the editor window of the source file in +question and put the cursor on the error line. + +If on the other hand you rather want the build be stopped on whenever an +error occurs, check the Abort on first error option +in this dialog. &kdevelop; will then call gmake +without the -k option. + + + +How to Run the Executable + +Once the build is complete, you can easily run the application from within +&kdevelop;. Use either Build +Execute Program, the +Shift F9 keys, or the +Execute program button in the Build +Toolbar of &kdevelop;. + + + + + + +Run the program from here. + + + +But where is the executable located which should be run? How does +one have &kdevelop; append options to the call? Or, how can I have the +application executed in a terminal by its own to test its console interactive +behavior? + +All this can be solved by configuring some project oriented run options in +&kdevelop;. Select Project +Project Options and then the +Run Options icon from the icon bar on the left dialog window +side. The Run Options dialog page will display to the +right. + + + + + + +Define where and how your program shall be run. + + + +Now, there is quite a lot which can be set up from this dialog. +Basically there are four groups of configuration items. + + + + +Directory +This tells &kdevelop; where it basically shall assume the +executable to be called. There are three possibilities you can select +from. + + +Note however that only root directories are defined here. +&kdevelop; usually looks for the executable in some subdirectory +given in the next configuration group. + + + +Run from the directory, where the executable was build the last +time. This is the default. You can keep this for now. + + + +Run from the build directory according to the currently selected +build configuration. +The name of this directory was set up on the General +Configuration dialog page. + +This is the root where &kdevelop; will find the executable. It +changes automatically with the selection you made in +Project +Build Configurations menu. Try it. + +Other than always running the most recently built executable according to +the setting above, this allows you to switch the program to be executed by +simply selecting another build configuration from the Project +menu. + + + +Run the executable found in a fixed custom directory. Again +this is the root only from where the actual executable is to be +found. + +Use this if you ⪚ want to run the actually installed program instead of +the version located in the project directories. + + + + + + +Program +This tells &kdevelop; the relative position and name of the +program it shall actually call. This is relative to the root directory +defined in the configuration group above. Furthermore you can define any +argument &kdevelop; will pass to the program when it is actually called. + + + +If leave the Main program text box empty, the +active target settings of the &automanag; will be used. +Although this is an expert setting, inadvertently leaving this input +field blank is a common cause of problems. Check this setting if &kdevelop; +appears not to call the executable you wanted. + + + + + +Environment Variables +&kdevelop; will set up a dedicated shell environment to run the +program in. Define any extra environment variable in this configuration +group. + + + + + +Miscellaneous +Two more check boxes are located at the bottom of this dialog page. + + + + +Automatically compile before execution comes +in handy most of time. &kdevelop; will check the project for changes and +perform necessary configure and build steps for you any time you command +it to run the program. + +Uncheck this in case you want to run the program version prior to the +last change. + + + +Start in external terminal is interesting if +you want to test the input/output behavior of non-&GUI; programs in a console +terminal. This is unchecked by default, so &kdevelop; does start the program in +a window of its own without console terminal I/O capabilities. + + + + + + + + + +How to Extend a Project — the &automanag; + +(- to be written -) + + +A Short Look at the Automake Machinery + +(- to be written -) + + + +How to Place Icons in a Separate Directory + +(- to be written -) + + + +How to Add New Classes + +(- to be written -) + + +Be careful when you select your class file names. It is extremely difficult to +change them later. + + + +What is in a Subproject? + +(- to be written -) + + +Concentrate on Your Work — the Active Target + +(- to be written -) + + + + +Some Steps to Restructure a Project + +(- to be written -) + + + + + +How to Debug + +(- to be written -) + + + + +A Note on Your Project Documentation + +The &kde; project uses docbook for +generating your project handbook (&ie; the user manual). The user manual is +available through your application menubar by choosing +Help +YourApplication +Handbook when your &kde; GUI application is running. +After building your project, the user manual is displayed in &kde; +&khelpcenter;. It should explain to the user how your application works, what +are the main features and how to configure it. It should also explain the +advanced features if any. + +All &kde; based templates in &kdevelop; have a doc subdir which contains +a index.docbook template in the en folder to get you +started in writing the user manual. You should edit this +index.docbook in &kdevelop; and start changing personal +details such as name, email, &etc;. Look at the comments in this file and try +following these indications to start your application documentation. Rebuild +your project to see the changes in &khelpcenter;. +You need to install your project using +Build +Install or Install (as +root user) in &kdevelop; to see the user manual in +&khelpcenter;. +You can find more about the docbook syntax on the &kde; documentation +website. + + + +Last But Not Least, Keyboard Shortcuts + +(- to be written -) + + + +Where to go from here + +(- to be written -) + + +Frequently Encountered Problems + + +The nutshell chapter +FAQ pages +Forum +Mailing lists + + + + +Working With Projects + +(- to be written -) + + +Using Existing &kdevelop; Projects + +(- to be written -) + + + +Importing External Projects + +(- to be written -) + + + + + diff --git a/doc/kdevelop/hello-world-app.png b/doc/kdevelop/hello-world-app.png new file mode 100644 index 00000000..6f2ab007 Binary files /dev/null and b/doc/kdevelop/hello-world-app.png differ diff --git a/doc/kdevelop/importdirectory.png b/doc/kdevelop/importdirectory.png new file mode 100644 index 00000000..3d0372ad Binary files /dev/null and b/doc/kdevelop/importdirectory.png differ diff --git a/doc/kdevelop/index.docbook b/doc/kdevelop/index.docbook new file mode 100644 index 00000000..993400c0 --- /dev/null +++ b/doc/kdevelop/index.docbook @@ -0,0 +1,372 @@ + +KDevelop"> --> + + + + + Apache"> + API"> + + autoconf"> + automake"> + + ctags"> + CVS"> + + Doxygen"> + doxywizard"> + egrep"> + grep"> + HTML"> + IDE"> + libtool"> + + Python"> + Perl"> + PHP"> + + Qt/embedded"> + ssh"> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +]> + + + + + + + &kdevelop; User Manual + + 2006-06-19 + &kdevrelease; + + + + Bernd + Gehrmann + +
bernd@kdevelop.org
+ + + + + Caleb + Tennis + +
caleb@aei-tech.com
+ + + + + Bernd + Pol + +
bernd.pol@online.de
+ + + + + Volker + Paul + +
volker.paul@tiscali.de
+ + + + + + 2002 + Bernd Gehrmann + + + 2002 + Caleb Tennis + + + 2004 + Bernd Pol + + + 2005 + Volker Paul + + + + + &FDLNotice; + + + &kdevelop; is an Integrated Development Environment to be used for a wide variety of programming tasks. + + + + KDE + KDevelop + IDE + development + programming + + + + + + +&survey-manual; +&getting-started; +&kdevelop-survey; +&setup; +&applicationwizard; +&editing; +&file-browsers; +&class-browsers; +&documentation; +&project-management; +&adv-build-management; +&debugger; +&cvs-chapter; + +&credits; + + + + +&kdevelop-install; +&nutshell; +&unixdev; + +&app-files; +&plugin-tools; +&app-uimodes-examples; +&commands; +&app-misc-info; +&app-changelog; + + + + + + + + + + + + + + + + +Bibliography + +(... to be written ...) + + + + +<ulink url="info://make/Top">GNU Make Manual</ulink> + +Richard M.Stallman +RolandMcGrath + + + + +<ulink url="info://automake/Top">GNU Automake</ulink> + +DavidMacKenzie +TomTromey + + + + +<ulink url="info://autoconf/Top">GNU Autoconf</ulink> + +DavidMacKenzie +BenElliston + + + + +<ulink url="info://gcc/Top">Using the GNU Compiler Collection</ulink> +Richard M.Stallman + + + +<ulink url="info://libtool/Top">GNU Libtool</ulink> + +GordonMatzigkeit +AlexandreOliva +ThomasTanner +Gary V.Vaughan + + + + +GNU Autoconf, Automake, and Libtool +1st edition +October 2000 + +Gary V.Vaughan +BenElliston +TomTromey +Ian LanceTaylor + +New Riders Publishing +ISBN 1578701902 + + + + +Advanced Programming in the &UNIX; Environment +1st edition +June 1992 +W. RichardStevens +Addison-Wesley Pub Co +ISBN 0201563177 + + + +Thinking in C++, Volume 1: Introduction to Standard C++ +2nd Edition +April 15, 2000 +BruceEckel +Prentice Hall +ISBN 0139798099 + + + +Open Source Development with CVS +2nd Edition +October 12, 2001 + +KarlFogel +MosheBar + +The Coriolis Group +ISBN 158880173X + + + +Programming PHP +1st edition +March 2002 + +RasmusLerdorf +KevinTatroe + +O'Reilly & Associates +ISBN 1565926102 + + + +Programming Python +2nd Edition +March 2001 +MarkLutz +O'Reilly & Associates +ISBN 0596000855 + + + +Gui Programming With Python : Using the Qt Toolkit +Bk&Cd-r edition +January 2002 +BoudewijnRempt +Opendocs Llc +ISBN 0970033044 + + + +Programming Perl +The Camel book +3rd Edition +July 2000 + +LarryWall +TomChristiansen +JonOrwant + +O'Reilly & Associates +ISBN 0596000278 + + + +Learning Perl +The Lama book +3rd Edition +July 15, 2001 + +Randal L.Schwartz +TomPhoenix + +O'Reilly & Associates +ISBN 0596001320 + + + + + + + + + +&documentation.index; + + diff --git a/doc/kdevelop/kdcop_browsing.png b/doc/kdevelop/kdcop_browsing.png new file mode 100644 index 00000000..26dbaaf1 Binary files /dev/null and b/doc/kdevelop/kdcop_browsing.png differ diff --git a/doc/kdevelop/kdevdesigner.png b/doc/kdevelop/kdevdesigner.png new file mode 100644 index 00000000..4fa74c68 Binary files /dev/null and b/doc/kdevelop/kdevdesigner.png differ diff --git a/doc/kdevelop/kdevelop-ideal-mode-0.png b/doc/kdevelop/kdevelop-ideal-mode-0.png new file mode 100644 index 00000000..ea2d7c50 Binary files /dev/null and b/doc/kdevelop/kdevelop-ideal-mode-0.png differ diff --git a/doc/kdevelop/kdevelop-ideal-mode.png b/doc/kdevelop/kdevelop-ideal-mode.png new file mode 100644 index 00000000..00e73804 Binary files /dev/null and b/doc/kdevelop/kdevelop-ideal-mode.png differ diff --git a/doc/kdevelop/kdevelop-install.docbook b/doc/kdevelop/kdevelop-install.docbook new file mode 100644 index 00000000..1ff5982c --- /dev/null +++ b/doc/kdevelop/kdevelop-install.docbook @@ -0,0 +1,754 @@ + + + + + BerndPol + Anne-MarieMahfouf + + + + +Installing &kdevelop; + + + installation + + +In this chapter we will discuss the steps necessary to compile and install the &kdevelop; IDE: + + + + How to obtain &kdevelop; mainly concentrates on downloading the most recent &kdevelop; sources from svn. + + + &kdevelop; requirements lists the programs and libraries which you need installed to successfully compile the IDE. + + + &kdevelop; compilation and installation leads you through all the steps of compilation and installation of the application. + + +How to obtain a &kdevelop; &API; documentation tells what an API is and how you get such a useful tool for navigating the &kdevelop; sources. + + + + + +How to Obtain &kdevelop; + + + obtain &kdevelop; + + &kdevelop; + obtain + + +&kdevelop; is available in binary form from many different &Linux; distributions such as SuSE, RedHat and others. These binaries are packed in some convenient format, mostly RPM, for easy installation. To install, follow the standard instructions given in your distribution. + + +You may as well obtain the &kdevelop; sources, compile and install them by yourself. These sources can be found via the project home page at http://www.kdevelop.org or via the &kde; ftp site. + + + +Get Daily &kdevelop; Snapshots from svn + + + svn + +If you want to be in front of current development, anonymous svn repository snapshots are available. +The module name is kdevelop at svn co svn://anonsvn.kde.org/home/kde/branches/KDE/3.5/kdevelop. + + + +Initial svn Checkout + + + checkout + + &kdevelop; + svn + checkout + + +To obtain an initial version of &kdevelop; you must download it from anonymous svn. For this so-called checkout operation follow these steps. + + + +We assume you want to put your &kdevelop; copy into the kde3src subdirectory of your home directory (~). + + + + + # Create the destination directory, if necessary: + + + ~> + mkdir kde3src + + + ~> + cd kde3src + + + ~/kde3src> + svn co svn://anonsvn.kde.org/home/kde/branches/KDE/3.5/kdevelop + + + ~/kde3src> + cd kdevelop + + + + + Once you have successfully checked out your &kdevelop; version, you may keep up with the changes using the update procedure shown in the next section. + + + + Keep the server load low. Please do not checkout every time you want to keep your &kdevelop; up to date! Use svn update for this purpose. + + + +Now you may compile your &kdevelop; version as shown in the &kdevelop; Compilation and Installation section. + + + + + +Keeping Your svn Copy up to Date + + + update + + &kdevelop; + svn + update + + +After you checked out (and successfully compiled) &kdevelop; from svn as shown above, you'll want to keep it up to date in order to get all the patches. Follow these steps. (We again assume you have put your &kdevelop; copy into the kde3src directory.) + + +Note the up (= update) command instead of the co (which stands for checkout). + + + + + ~> + cd kde3src + + + ~/kde3src> + cd kdevelop + + + ~/kde3src> + svn up + + + + +Keep an eye on the messages svn produces during the update sequence. The exact steps in the compilation sequence depend on this. + + + +Now you can compile a new &kdevelop; version as shown in the Special svn compilation considerations chapter. + + + + + + + + + + +&kdevelop; Requirements + + + requirements + + &kdevelop; + requirements + + GNU + requirements + + +In order to successfully compile and use &kdevelop;, you need the following programs and libraries. They are available on most platforms as distribution packages and thereby can be installed easily. + + + +Required: + + + gcc/g++ ≥ 2.95.3 (or compatible) + + gcc + requirements + + g++ + requirements + + + Available from gcc.gnu.org + + + + + &GNU; make (or compatible) + + make + requirements + + + Available from www.gnu.org/software/make + + + + + &perl; 5.004 (or higher) + + Perl + requirements + + + Available from www.perl.com + + + + + autoconf ≥ 2.52 (or higher) + + autoconf + requirements + + + Available from www.gnu.org/software/autoconf + + + + + automake ≥ 1.6 (or higher) + + automake + requirements + + + Available from www.gnu.org/software/automake + + + + + flex 2.5.4 (or higher) + + flex + requirements + + + Available from www.gnu.org/software/flex + + + + + &Qt; ≥ 3.3.0 (or higher) + + Qt + requirements + + + Available from www.trolltech.com/products/qt + + + + + KDE ≥ 3.4.0 (or higher) + + KDE + requirements + + + Available from www.kde.org + + + + + +Optional: + + The ctags source navigation tool, from http://ctags.sourceforge.net, which enables you fast access to declarations and definitions by a few simple clicks on a name in the editor. + ctags + + + dot, a graphics language compiler, from http:/www.graphviz.org. This + + tool is needed in conjunction with &doxygen; below if you want to have class relationships graphically displayed (which is highly recommended). + dot + + + The &doxygen; documentation tool, from http://www.doxygen.org if you want to generate concise and powerful API documentation from your projects. + doxygen + + + valgrind from http://developer.kde.org/~sewardj/ helps you to find memory management problems in your applications. + valgrind + + + svn from http://subversion.tigris.org/ if you want to use the svn versioning system. + + svn + requirements + + + Any other compiler and/or tool in case you want to develop for another language/platform than C++/&kde; or use some special facility. + + + + + + + + You can, to a certain extent, circumvent the need for &autoconf; ≥ 2.52 and &automake; ≥ 1.6. Just remove the admin directory in your &kdevelop; installation directory and type + + autoconf + circumvent version need + + automake + circumvent version need + + version need + circumvent for autoconf/automake + + + (your-kdevelop-directory)> + ln -s $KDEDIR/share/apps/kdelibs/admin admin + + + at the console. This causes &kdevelop; to use the standard settings in the &kde; admin directory instead. + + + + + Be careful not to mix &Qt; versions. Always link &kdevelop; to the same &Qt; version your &kde; library was compiled. Otherwise you will most likely experience very strange behaviours. + + + + + + + + + + +&kdevelop; Compilation and Installation + + + &kdevelop; + compilation + + &kdevelop; + installation + + +Once all requirements are met, you are ready to compile and install &kdevelop;. This appendix will discuss the necessary steps to do so. + + + + Preliminary Steps tells you about setting up a proper environment. + + + Compile &kdevelop; deals with obtaining the &kdevelop; sources from svn, how to prepare them for the installation process, and finally shows the steps necessary to compile and install &kdevelop;. + + + Some Notes on configure Options tells you how to run &kdevelop; if it has been installed in a location other than the &kde; directory. + + + + +Preliminary Steps + + + preliminaries + &kdevelop; installation + + KDEDIR + + QTDIR + + LD_LIBRARY_PATH + + LIBRARY_PATH + + PATH + + +Before entering the compile sequence you must make sure all libraries and tools are available to the make system. To accomplish this some environment variables need to be properly set. The actual steps to be performed depend on the console shell you use. + + + +To avoid typing in all the statements that set the necessary environment variables every time you want to compile, you should put them into your .bashrc or .cshrc file. This way the environment variables will be properly set every time you start the shell. + + + +Setting the Environment for the bash Shell + + +If you use the bash shell add the following lines: + + + + export KDEDIR=(path to your KDE installation) + export QTDIR=(path to your Qt library) + export LD_LIBRARY_PATH=$QTDIR/lib:$KDEDIR/lib:$LD_LIBRARY_PATH + export LIBRARY_PATH=$QTDIR/lib:$KDEDIR/lib:$LIBRARY_PATH + export PATH=$QTDIR/bin:$KDEDIR/bin:$PATH + + + + + + +Setting the Environment for the tcsh Shell + + +If you use the tcsh shell add the following lines: + + + + setenv KDEDIR (path to your KDE installation) + setenv QTDIR (path to your Qt library) + setenv LD_LIBRARY_PATH=$QTDIR/lib:$KDEDIR/lib:$LD_LIBRARY_PATH + setenv LIBRARY_PATH $QTDIR/lib:$KDEDIR/lib:$LIBRARY_PATH + setenv PATH $QTDIR/bin:$KDEDIR/bin:$PATH + + + + + + + + +Compile &kdevelop; + + + make + &kdevelop; installation + + compiling + &kdevelop; + + +In the following discussion we assume that you have put your &kdevelop; sources in the ~/kde3src/kdevelop directory. + + + +Special svn Compilation Considerations + + +In case you use a &kdevelop; snapshot from svn the initial compilation steps depend on whether you just did a complete checkout or only updated the source. + + + + +After a svn Checkout + + +You must initialize the make system after a fresh checkout. The same is true every time you need to start over from scratch. Type: + + + + ~/kde3src/kdevelop> + make -f admin/Makefile.common svn-clean + + +and then all of the following steps. + + +You might need access to the svn repository for the clean-up if any corrupted or missing files must be reconstructed. + + +The svn-clean command will remove every file not in svn from the directory! Make sure to back up any valuable information before you issue this clean-up command. + + + + + +After a svn Update + + +The next step depends on the output of the svn update sequence. If you got something like (there may be a U or a P marker in the leftmost column, both denoting the file has been changed): + + + +U /some_directory_path/Makefile.am + + +or if you just did a full checkout, you must enter: + + + ~/kde3src/kdevelop> + make -f Makefile.svn + + +before you proceed with all of the following steps. + + + + + + + +Basic <command>make</command> Command Sequence + + +Once the basic make system is set up you must decide which type of the &kdevelop; system you want to use. This is done in the following configure step which builds the actual Makefiles the make command will use. + + + +You may drop the option in the following configure command lines if you want &kdevelop; be installed in the default &kde; directory. See the Some notes on configure options chapter for this. + + + + +A Debug-Compiled Version + + +If you want to keep track of what your &kdevelop; application does at run-time you may build a debug-compiled version. Just command configure to do so: + + + + ~/kde3src/kdevelop> + ./configure --enable-debug=full --prefix=(where-your-kde3-is) + + + + + +A Release-Compiled Version + +If you only want to use &kdevelop; as-is a (smaller and faster +running) release version suffices. configure defaults to +this. + + + ~/kde3src/kdevelop> + ./configure --prefix=(where-your-kde3-is) + + + + +If you want to build your own API documentation for &kdevelop; you must include yet another option in the configure command: + + + ~/kde3src/kdevelop> + ./configure --(options-as-above) \ --with-kdelibsdoxy-dir=$KDEDIR/share/doc/HTML/en/kdelibs-apidocs + + + + + + +Make and Install &kdevelop; + + +configure will check the system and build some Makefiles according to what it found. The make command will use the main Makefile by default. Thus + + + + ~/kde3src/kdevelop> + make + + +suffices. If necessary, now gain root user rights using the command + + + ~/kde3src/kdevelop> + su + + +and entering the root password. Then install the application: + + + ~/kde3src/kdevelop> + make install + + +That's all. If you installed &kdevelop; in the default &kde; directory you may now run the IDE. Otherwise some additional steps will be necessary as shown in the Non-default installation directory section below. + + + + + In fact there usually will have been three &kdevelop;-based applications installed: + + + The &kdevelop; IDE — this is the place where you will usually work. + The stand-alone &kdevelop; Assistant documentation browser — isolates all the powerful documentation facilities of the &kdevelop; IDE in a separate tool. This comes in handy when you want to look up some programming documentation but do not want to start the full IDE. + The &kdevelop; Designer — enhances the &Qt; User Interface Designer by &kde; specific elements and integrates nicely in the &kdevelop; IDE. + + + + + + + + + + + + +Some Notes on <command>configure</command> Options + + +Non-default Installation Directory + + + &kdevelop; + installation + non-default directory + + non-default directory + + KDEDIRS + + kbuildsycoca + + +By default configure prepares the IDE to be installed in the default &kde; directory. This is necessary because &kdevelop; assumes direct access to some tools and parts which reside there. If want to use your own installation directory, you must tell configure this by the option: + + + ~/kde3src/kdevelop> + ./configure --prefix=(where-your-kde3-is) + + +There is a caveat if you do so. You must provide a means for &kdevelop; to access the needed tools and parts in the &kde; directory when running. (You can still use the IDE without doing so, but with very restrained capabilities.) + + +Call up a shell and have the following commands executed before you start &kdevelop; at the shell prompt. + + + + Take care to use the plural: It is KDEDIRS, not just KDEDIR) + + + + + ~> + export KDEDIRS=/usr/local/kde:/opt/kde3 + + + ~> + kbuildsycoca + + + (Now start &kdevelop;:) + + + ~> + kdevelop + + + + + The KDEDIRS environment variable must be set to the list of active &kde; directories in your system. We use + /usr/local/kde:/opt/kde3 + as an example only. + The /usr/local/kde directory may for instance contain an incomplete &kde; version you compiled for debug purposes, and the /opt/kde3 directory may in addition contain the standard &kde; version from your distribution that is used for everyday work. + + + +In a tcsh shell you must set the environment variables using: + + + ~> + setenv KDEDIRS /usr/local/kde:/opt/kde3 + + +The kbuildsycoca command (build system control cache) looks around for libraries and caches their location and version, so that &kdevelop; can find them. The caveat is that it takes noticeable time—and it has to be run any time you call up the shell to start &kdevelop; from a non-default directory. You may want to put the above commands into a shell script to reduce the typing effort. + + +(You could as well put the lines in your .bashrc or .cshrc file, but this is not advisable as kbuildsycoca will then be run any time you call up the shell.) + + + +The kbuildsycoca command does not run from within the root. You must call it from a non-root user. (But is not a very good idea after all to do software development from within the root!) + + + + + + + + + + +How to Obtain a &kdevelop; API Documentation + + + API + &kdevelop; + + &kdevelop; + API + + compiling + &kdevelop; + API + + configure + &kdevelop; API + + +API is the short form of Application Program Interface. Actually such an API cotains a series of descriptions (&ie; calling conventions) by which an application program can access the operating system and other services. In our context, however, a broader definition was adopted. The API of a &kde; or &Qt; application is an abstract of the classes and methods interfaces, a synopsis to be used like a dictionary to navigate the sources. + + +There is a version of the most current API available at the KDevelop-Home website. It will be automatically updated every 24 hours so you can keep up. + + +Alas, this version is best used read-only over the internet. If you do not always have internet access you may as well build your own API documentation from the &kdevelop; sources. To do so, you must tell the automake system where to find the KDELIBS API in your system. This is accomplished by the special option in the configure command when you prepare to compile the &kdevelop; sources: + + + + + ~/kde3src/kdevelop> + ./configure --(options-as-usual) \ + + + --with-kdelibsdoxy-dir=$KDEDIR/share/doc/HTML/en/kdelibs-apidocs + + + + +(make will replace the global $KDEDIR variable with the actual &kde; directory setting recorded therein.) Then issue a make command as usual. After the &kdevelop; IDE has been built you have the option to build the API as well. For this you must issue + + + ~/kde3src/kdevelop> + make apidocs + + + +This will build a Doxyfile in your &kdevelop; base directory which in turn will be processed by the Doxygen application to build quite a lot of .html API files. When this rather lengthy API building process (may last more than an hour on a slow system) finally comes to an end, you must install the API just like you have to install the &kdevelop; IDE itself. If necessary obtain superuser rights by + + + + ~/kde3src/kdevelop> + su + + + +and entering the root password. Then install the API files: + + + + ~/kde3src/kdevelop> + make install-apidox + + + +Once this is done, make will inform you about the directory where you can finally look at the API documentation's contents. Note this address, you can use it from &konqueror; as well as from inside &kdevelop;, in case you have set up the &kdevelop; sources themselves as a project to work on. + + + +You will most probably see a lot of warning and/or error messages during the API build run by Doxygen. It is best to ignore them, they are of interest to the &kdevelop; developers only. If the API generation ever comes to a successful end, the .html API files will be usable. + + + + + diff --git a/doc/kdevelop/kdevelop-mdi-mode.png b/doc/kdevelop/kdevelop-mdi-mode.png new file mode 100644 index 00000000..51ed019a Binary files /dev/null and b/doc/kdevelop/kdevelop-mdi-mode.png differ diff --git a/doc/kdevelop/kdevelop-scripting.docbook b/doc/kdevelop/kdevelop-scripting.docbook new file mode 100644 index 00000000..d9e59bb5 --- /dev/null +++ b/doc/kdevelop/kdevelop-scripting.docbook @@ -0,0 +1,56 @@ + + + + + IanGeiser + + + + +Using Scripts in KDevelop + + +Running Scripts + + To access a script that is available to &kdevelop; use the ToolsScripts menu. If there there is no such menu item then there are no installed scripts available to KDevelop. + + + + +Adding Scripts + + Once you have added KScript support to your host application adding the scripts is just as easy. The scripts are comprised of two parts, a desktop file that contains meta-data about the script and the script itself. This approach was used because of security and simplicity. The desktop file provides meta-information for menus and script type. This keeps the host application from having to inspect for load each script. An example of this file is shown below: + + + The above example demonstrates the main parts that KScript will look for. The first item the "Name" is the name that will appear to the user in the host application and the "Comment" will be usually provided as a tool tip. The "Type" is the most important. This is used to select the proper script engine to run the script. Currently the ones available to KDE are "ShellScript/bash" and "JavaScript/kjs" +The next step is to create the actual script. For the above example the Type of script that is used is "ShellScript/bash". The shellscript script engine provides a few things for the developer. The first element is the DCOP ID of the host application. This is passed to the script as the first argument. This means from anywhere in the script the value of "$1" will return the host's DCOP ID. An example shell script is shown below: + + +This script is quite simple and just executes a command and sets the text of the first document to the output of "ls -l" + +One of the most useful tools in developing scripts for applications is the KDCOP application. +
+ KDCOP Browsing DCOP Interfaces in &kdevelop; + + + +
+ +The KDCOP tool allows script developers to browse and debug the current interfaces of the host application. KDCOP also provides a neat feature of allowing users to select a method and drag the current code to their text editor. This simplifies use for people who are not savvy to the DCOP methods of the host language. Currently KDCOP supports KJSEmbed, Python, and UNIX Shell method for accessing DCOP. + +Once the script is complete it is ready to be installed. Application developers should document the location that will be scanned for scripts. In the case of the above example for Kate the scripts are located in "$KDEDIRS/share/apps/kate/scripts". + +
+ &kdevelop; Scripts on the Filesystem + + + +
+ +The script desktop file, and its associated script should be in the same directory. For script developers it is also recommended that all other script resources such as UI files, or data files should also reside in the script directory. In the above example the script will appear under the Tools->KDE Scripts menu. One important thing for script developers to note is that they should not perform operations that could block for a long time, or go into an eventloop. This is because the current version of the script interface is geared for automated tasks that run until completion. This is being addressed and extended for KDE 4. + + + + + + diff --git a/doc/kdevelop/kdevelop-survey.docbook b/doc/kdevelop/kdevelop-survey.docbook new file mode 100644 index 00000000..9fe32d2d --- /dev/null +++ b/doc/kdevelop/kdevelop-survey.docbook @@ -0,0 +1,489 @@ + + + + + BerndPol + + + + +Overview of &kdevelop; Features + + + &kdevelop; + survey + + overall view + + survey + + +&kdevelop; integrates a lot of tools, scripts, and templates in a common user interface. Basically it consists of + + + + several user interface modes from which you can select the look and feel of the workspace, + + + an &appwizard; which aids you in setting up a new project, + + + several project management systems which aid in building and managing your project, + + + some editing tools to easily work on your program texts + + + various file browsers providing you different views on your file system, + + + various class browsers to aid you in maintaining the classes and their relationships of your object-oriented programming project, + + + a debugger interface to find and remove program errors from within &kdevelop;, and + + + several plugin tools, extensible modules which can be loaded at runtime and on demand. This allows you to only turn on those features you really need. + + + a set of other diagnosis, documentation, and optimization helper tools. + + + + + + + In fact there are three &kdevelop;-based applications: + + + The &kdevelop; IDE — this is the place where you will usually work. + The stand-alone &kdevelop; Assistant documentation browser — isolates all the powerful documentation facilities of the &kdevelop; IDE in a separate tool. This comes in handy when you want to look up some programming documentation but do not want to start the full IDE. + The &kdevelop; Designer — enhances the &Qt; User Interface Designer by &kde; specific elements and integrates nicely in the &kdevelop; IDE. + + + + + +Available User Interface Modes + + + &kdevelop; + user interface modes + + user interface + &kdevelop; modes + + UI modes + + Child Frame Windows + + Tabbed Pages + + Toplevel Windows + + IDEAl + + +&kdevelop; offers developers four separate user interface modes (click on the mode name to view an example): + + IDEAl + + This is a novel user interface approach optimizing both work space and intuitive handling of the tools. + + + + All tool views are docked in a tabbar fashion around the mainframe area. They are grouped left, bottom, and right according to the services provided. + + + Editor and browser views will be stacked in a big sized tabbed window inmidst the mainframe area. + + + + + + Child Frame Windows + + All tool views are initially docked to the mainframe. + Editor and browser views will live like toplevel windows within a view area of the mainframe. + + + + + Tabbed Pages + + + All tool views are initially docked to the mainframe. + + + Editor and browser views will be stacked in a tabbed window. + + + + + + Toplevel Windows + + + All editor, browser, and tool views will be toplevel windows directly on the desktop. + + + The main widget only contains the menu, toolbars, and statusbar. + + + + + + + + +How to Switch User Interface Modes + + + user interface + switch modes + + switch UI modes + + +To switch the user interface mode select Settings Configure KDevelop... from the menus. The Customize KDevelop dialog will pop up, where you have to select User Interface in the left hand tree. This will display the settings page shown below. + + + + + + + + + Select a user interface mode + + + + + +(Older &kdevelop; versions provide the top mode selection section only.) + + + +In the Major User-Interface Mode section select the radio button of the user interface mode you want to work in. + + +Dependent on the user interface mode you selected, other configuration sections will become available where you can taylor more details of the look and feel to your preferences. See the Selecting the User Interface chapter for more detail. + + + +Do not forget to restart &kdevelop; in order to let your selections take effect. + + + + + +How to Maximize the Work Space Area + + + &kdevelop; + work space + + &kdevelop; + maximize work space + + user interface + work space + + user interface + menubar + + user interface + full screen mode + + full screen mode + + menubar + hide/unhide + + hide menubar + + unhide menubar + + +To maximize space, there is a full-screen window mode available which expands the mainframe area to the screen borders. Additional space can be reclaimed by hiding the menubar. And you can of course hide any toolbar as usual in KDE applications. + + + + +Full Screen Mode + + +To switch to or from full screen mode select +View Full-Screen Mode + from the menus or press +&Ctrl;&Shift;F . There is also a +Full-Screen Mode icon in the Browse +Toolbar available. + + + + +Hide/Unhide the Menubar + + +To hide the menubar select Settings Show Menubar from the menus or press &Ctrl;M . You may also include a Show Menubar icon in a suiting toolbar, ⪚ the Browse Toolbar for that purpose. To unhide the menubar you must press &Ctrl;M or use the Show Menubar icon if available. + + + + + + + + + + + + +Elements of the User Interface + + +(... to be written ...) + + + +The Workarea + + +(... to be written ...) + + + + +The &kdevelop; Titlebar + + +(... to be written ...) + + + + +The &kdevelop; Statusbar + + +(... to be written ...) + + + + +The menubar + + +(... to be written ...) + + + + +The Toolbars + + +(... to be written ...) + + + + +The Tree Tool Views + + +(... to be written ...) + + + + +The Output Tool Views + + +(... to be written ...) + + + + + + + + +Project Management Systems + + + project management + + +Globally, a project will rely on some form of project management system. &kdevelop; offers four project management systems the programmer can select from when creating a new project. + + + + Automake projects use the &GNU; standard development tools. + + + QMake projects use the trolltech QMake project manager. + + + ANT projects use the Apache ANT project manager for &Java; development. + + + Custom projects require you to maintain your own Makefiles. + + + + + +Automake Projects + + + projects + automake + + automake + projects + + +Projects created with &kdevelop;'s &automanag; make it very easy for developers to use the &GNU; standard development tools. They provide + + + a better way of Makefile generation and + + + a good and safe way for fast adaption towards different systems by autoconf-generated configure scripts. + + + + + + +QMake Projects + + + projects + qmake + + qmake + projects + + +For developers who enjoy the flexibility and feel of &Qt;'s qmake system, &kdevelop; offers the ability to handle qmake based projects (.pro files) within the &GUI;. + + +For more information on the QMake project manager see the qmake User Guide which should be included in your distribution or have a look at the TROLLTECH Documentation home page where you may find the QMake documentation of your Qt C++ GUI Application Development Toolkit version. + + + + +CMake Projects + + + projects + cmake + + cmake + projects + + +CMake will be the &kde; build system for &kde; 4 and &kdevelop; already +provides you some CMake based templates in C and C++. You only need the cmake +program in your $PATH to build them. + + +To set up a new C or C++ project in &kdevelop; select +Project +New Project... +C or C++ +CMake based projects +A shared library template or Hello world program +. + + + + +ANT Projects (&Java; Projects) + + + projects + ant + + ant + projects + + projects + Java + + Java + projects + + development + Java + + +&Java; developers may want to use the Apache ANT project manager for their projects. To set up a new Ant project in &kdevelop; select Project +New Project... +Java +Ant Project +Application. + + +For more information see The Apache Ant Project home page. + + + + +Custom Projects + + + projects + custom + + custom projects + + Makefile + custom projects + + +If you prefer to maintain your own Makefiles for your project you may use the custom project option of &kdevelop;. This may be feasible in unusually structured projects or if you want to retain full control over the make process. + + +Yet, if you do not really need the extra flexibility and control of the custom project manager you should consider &automanag; or one of the other project managers, because they considerably ease the program building and distribution processes. + + + + +How to Distribute Your Application + + + distribution + + application + distribution + + binary packages + + +The distribution of your applications does not require the end-user to have anything different installed other than + + an appropriate compiler, + a linker, and + the appropriate development libraries, + + + +which at least for C++ applications is most often the case. But you can as well distribute binary packages of your application. + +In either way, the end-user of your product does not need &kdevelop; installed. + + +For giving away your sources, we advise to include the project file of &kdevelop; as well. This makes it very easy for other developers—if they use &kdevelop;—to work with your sources. + + +For projects where several developers, maybe working on different places, are involved, this should be the case anyway. So you can ensure consistency of the Makefiles to not run into trouble. + + +Especially on multi language applications, translators won't actually work with the source code, except in cases that require correction for enabling translation support. + + + + + + + diff --git a/doc/kdevelop/kdevelop-tabbed-mode.png b/doc/kdevelop/kdevelop-tabbed-mode.png new file mode 100644 index 00000000..faa7a97f Binary files /dev/null and b/doc/kdevelop/kdevelop-tabbed-mode.png differ diff --git a/doc/kdevelop/kdevelop-toplevel-mode.png b/doc/kdevelop/kdevelop-toplevel-mode.png new file mode 100644 index 00000000..c2fb812b Binary files /dev/null and b/doc/kdevelop/kdevelop-toplevel-mode.png differ diff --git a/doc/kdevelop/listplugins.sh b/doc/kdevelop/listplugins.sh new file mode 100755 index 00000000..e21b3a15 --- /dev/null +++ b/doc/kdevelop/listplugins.sh @@ -0,0 +1,43 @@ + +# kdevdir must be set to the KDevelop project directory. +kdevdir=/home/volker/data/prj/kdevelop/kdevelop/ +# The plugins are in the parts/ subdirectory. + +pushd $kdevdir/parts >/dev/null +oldscope=nix +echo "The following plugin list is generated by a small script" +echo "written by Volker Paul. All plugins have a .desktop file" +echo "where information such as name and comments are written." +echo "If in the following these comments are not very useful," +echo "it is because the plugin authors made them this way." +echo "The plugins are grouped by scope (Core, Global, Project)." + +for defscope in Core Global Project; do + if [ $defscope != $oldscope ]; then + oldscope=$defscope + echo +# echo "Scope: $defscope" + echo "Scope: $defscope" + echo "" + fi + for dir in `ls`; do + if [ ! -d $dir ]; then continue; fi + dfile=$dir/*.desktop + # echo $dfile | wc -w + if [ `echo $dfile | wc -w` -gt 1 ]; then continue; fi + if [ ! -f $dfile ]; then continue; fi + scope=`cat $dfile | grep "X-KDevelop-Scope=" | cut -d= -f2-` + if [ $scope != $defscope ]; then continue; fi + comment=`cat $dfile | grep "Comment=" | cut -d= -f2-` + name=`cat $dfile | egrep "^Name=" | cut -d= -f2- | tr " " _` + genericname=`cat $dfile | grep "GenericName=" | cut -d= -f2-` + echo "" + echo "$genericname" + echo "$comment" + done + echo "" +# echo "" +done +popd >/dev/null +echo "So far the generated plugin list." +echo diff --git a/doc/kdevelop/loading-progress-bar.png b/doc/kdevelop/loading-progress-bar.png new file mode 100644 index 00000000..f786721d Binary files /dev/null and b/doc/kdevelop/loading-progress-bar.png differ diff --git a/doc/kdevelop/nutshell.docbook b/doc/kdevelop/nutshell.docbook new file mode 100644 index 00000000..1c5395dd --- /dev/null +++ b/doc/kdevelop/nutshell.docbook @@ -0,0 +1,242 @@ + +In a Nutshell — Tips and Tricks + + + + +The information in this chapter is meant as a quick reference for a head start or if you (momentarily) forgot about some basic concept. There are also short hints on how to solve some common problems when working with &kdevelop;. + + +If you want more information on a topic, just follow the link in the title starting that advice. + + +Information on these topics is availabe: + + + Look and Feel + Projects + Compilation + &automanag; + Compile/Make Problems + Other Topics + + + +Look and Feel + + +Force +smaller tool view tabs in IDEAl Mode + +By default &kdevelop; starts with large text-based tool tip tabs +around the work area. You may change this look to ⪚ save space in the +&kdevelop; configuration dialog (Settings +Configure KDevelop... User +Interface). +If you use an older &kdevelop; 3 version, this configuration dialog +may not be available. To change the toolview tabs display manually, place a + entry under the + tag in your +$KDEHOME/share/config/kdeveloprc configuration file as +follows: + + +: icons only +: text only (default) + +: icons and text + + + + + +Weird colored characters and/or display +style + +If you notice random colored letters everywhere (&ie; on tabs, on tool +bars, etc.) and the &kdevelop; window seemingly uses a wrong display style, +this may help: + + +In your +$KDEHOME/share/config/kdeveloprc +configuration file find the line containing +Style=Checked and remove +it. Then restart &kdevelop;. + + + +(This behaviour does sometimes occur after you left clicked a .ui file +in one of the file navigators and &kdevelop; did load +KUIViewer to show the &GUI; which was produced +from this file.) + + + + +Full +screen mode + +Select ViewFull-Screen +Mode from the menus or press +&Ctrl;&Shift;F. + + + + +Hide/Unhide +the menubar + +To hide the menubar select +SettingsShow +Menubar from the menus or press +&Ctrl;M. To redisplay the menubar only +&Ctrl;M is available. + + + + + +Projects + +Create New Project + +ProjectNew +Project... will start the &appwizard;. + + + + +Create a custom project + +There is no direct way to create a custom project (&ie; a project +which does use its own makefiles). Use +Project Import Existing +Project instead. Remember to set the appropriate +Project Type, labeled by an additional (Custom +Makefiles), in the dialog. + + + + +Use project options early + +Whenever you start a new project do not forget to set the +Project Project +Options... to your needs. + + + + + +Compilation + +Missing detail in compilation +messages + +If during compilations you notice some valuable information is missing +in the Messages Output View window, it may be that the +level of message detail is set too low. &RMB; click in the window and select +another detail level from the context menu. + + + + + + + + +<link linkend="automake-manager">&automanag;</link> + + +Create new files in a project + +Select the sub-project in the upper half of the &automanag;, then +&RMB; click in the lower half on the groups title you want to have the files +added and select Create New File.... + + + + +Add existing files to a project + +Select the sub-project in the upper half of the &automanag;, then +&RMB; click in the lower half on the groups title you want to have the files +added and select Add Existing Files.... + + + + +Remove a file from a project + +Select the sub-project in the upper half of the &automanag;, then in +the lower half open the groups list you want to have the file removed from, +&RMB; click on the file in this list and select +Remove. + + + + + +Compile/Make Problems + +Project does not build again after switching +to/from default target + +There is a problem with the &automake;/&autoconf; machinery. If + Project Build +Configuration provides to select from three build +directories: default, +optimized, and debug, +by all means stick to either the default +or the debug/optimized targets. + + +Once you configured your project with default it will no longer build +with debug or optimzed. + + +Once you configured your project with debug or optimzed it will no +longer build with default. + + + + + + +Wrong +autoconf version &etc; Error + +There are several error messages concerning too old versions of +autoconf &etc; prohibiting +configure to work properly. Run +autoreconf in the directory tree where the +configure.in files in question are. This command will +try to update the information in the &GNU; Build System files. See +man autoreconf for more information. + + + + + +Other Topics + +Configuration +Files used by &kdevelop; + +Usually you should not need to care, but this is very useful to know +in case something went wrong with your setup. + + + + + diff --git a/doc/kdevelop/open-project.png b/doc/kdevelop/open-project.png new file mode 100644 index 00000000..c7b1ee20 Binary files /dev/null and b/doc/kdevelop/open-project.png differ diff --git a/doc/kdevelop/open-recent-project.png b/doc/kdevelop/open-recent-project.png new file mode 100644 index 00000000..20a1adc6 Binary files /dev/null and b/doc/kdevelop/open-recent-project.png differ diff --git a/doc/kdevelop/plugin-tools.docbook b/doc/kdevelop/plugin-tools.docbook new file mode 100644 index 00000000..1c07cb7a --- /dev/null +++ b/doc/kdevelop/plugin-tools.docbook @@ -0,0 +1,433 @@ + +Plugin Tools + + + plugins + + +&kdevelop; contains a large number of little tools that help you to perform +certain task. Most of them are realized as plugins. That means, if you do not +need a plugin, you can disable it. +That also means, if you are looking for a functionality that should be there +and isn't, then maybe it's implemented in a plugin and that plugin is disabled. +For example, in the file menu there is a Quick Open feature, but only if +it's enabled in the Project - Project Options dialog. + + +Technically, plugins are based on the KDevPlugin class defined in +lib/interfaces/kdevplugin.h. The following is taken from a comment from there. + + +KDevPlugin is the base class for all KDevelop plugins. +A plugin is a component which is loaded into KDevelop shell at startup or by request. +A plugin has a scope that can be either: + +Core +Global +Project + + + +Core plugins are global plugins which offer some important "core" functionality and thus +are not selectable by user in plugin configuration pages. + +Global plugins are plugins which require only shell to be loaded and do not operate on +KDevProject interface and/or do not use project wide information. +For example, the uimode plugin allows a developer to select which user interface they wish to use. + + +Project plugins require a project to be loaded and are usually loaded/unloaded along with the project. +If a plugin operates on project-related information then it is a project plugin. +The Automake Manager, for example, only needs to be active when an Automake based project is currently loaded. + + +As stated above, core plugins cannot be disabled. Global plugins can be +enabled/disabled in Settings +Configure KDevelop... +under Plugins. +Project plugins can be +enabled/disabled in Project +Project Options... +under Plugins. +Active plugins can have many effects on KDevelop. +Depending on their function, they may add extra menus, extra menu items, extra tool buttons, etc. + + +Plugins which are disabled do not clutter your menus and are not loaded +into memory. + + + +The following plugin list is generated by a small script +(listplugins.sh) written by Volker Paul. All plugins have a .desktop file +where information such as name and comments are written. +If in the following these comments are not very useful, +it is because the plugin authors made them this way. +The plugins are grouped by scope (Core, Global, Project). + +Scope: Core + + +Application Wizard +Application Wizard + +Difference Viewer +Difference Viewer + +FileCreate +FileCreate + +FullScreen +FullScreen + +Tip of the Day +Tip of the Day + +User-Interface Selection +Provides a dialog for UI-mode selection. + +VCSManager +Version Control System Manager + + +Scope: Global + + +Abbreviation Expansion +Provides support for customizable abbreviations - short words which expand into commonly needed code structures. + +Documentation +The Documentation plugin offers browsing and searching in local and online documentation with support for multiple documentation systems. + +FileList +Provides a list of all currently open files. (Handy when the tab bar is not quite wide enough.) + +File Selector +Powerful network transparent file browser utility. + +Shell Filtering and Insertion +Provides a way of manipulating editor text using commandline tools. Appears in the Tools menu. + +Grep Frontend +Integrates "find|grep" in KDevelop - allows fast searching of multiple files using patterns or regular expressions. + +Embedded Konsole +This plugin gives KDevelop an embedded konsole for quick and easy command line access. + +"Open with" Menu Addon +This plugin provides additional "open" alternatives for various context menus in KDevelop. + +Part Explorer Tool +A Graphical tool for performing KTrader-like queries about registered services + +Regular Expression Tester +Tool to design and test regular expressions against common regexp syntaxes. + +Replace Part +This plugin is an interactive projectwide "Search and Replace" tool. Search using string or regexp matching, and select the replacements to be made from a preview before the action is finalized. When loaded it appears in the Edit menu. + +Scripting +The Scripting plugin offers KScript based scripting of the KDevelop application + +Code Snippets +This plugin allows you to store code snippets and add them to your code + +Text Structure +Provides a structure overview and navigation for HTML and TEX files + +Tools Menu Addition +This plugin provides an easy way to add external applications to the Tools menu and toolbar. + +Valgrind Frontend +Valgrind is a tool that helps you find memory management problems in programs. http://developer.kde.org/~sewardj/ + + +Scope: Project + + +annotation Plugin +annotation Description + +Source Code Formatter +A plugin for formatting of sourcecode according to a specified set of rules. When loaded it is found in the Tools menu. + +Bookmarks +Plugin that provides navigation and overview of active source bookmarks and persists them between sessions. + +Class View +This plugin displays a graphical view of all the classes in the project, complete with methods and attributes, and provides a way of direct source navigation. + +CopyTo +Simple file uploader plugin. It does a file copy over any KIO supported protocol. + +CTags Frontend +CTags is a source navigation tool with support for many languages. When loaded it provides a context menu for finding type declarations/definitions and also a query dialog. http://ctags.sourceforge.net/ + +Final Packaging Support +Aids in building and publishing the final project. Only RPM package format is supported for now. + +Doxygen Support +The doxygen plugin provides a way to specify and control generation of documentation for a project, based on source code content. You need to have doxygen installed to be able to use this. For more info goto http://www.doxygen.org + +QuickOpen +Provides an efficient way of finding/opening files, classes and methods in a large project. Appears in the File and Tools menus when loaded. + +Security Checker +Code security checker + +So far the generated plugin list. + + + +Project Management Plugins in &kdevelop; + + + antproject + ANT Project Manager (&Java; applications) + + + autoproject + Automake Project Manager + + + customproject + Custom Project Manager + + + trollproject + QMake based Project Manager + + +
+The above plugins are currently (May 2005) empty. Maybe +project management support will be implemented as plugins +in the future. + + + +Language Support Plugins in &kdevelop; + + +cppsupportSupport for C/C++ +fortransupportSupport for Fortran +javasupportSupport for &Java; +perlsupportSupport for Perl +phpsupportSupport for PHP +pythonsupportSupport for Python + +
+ + +In the following, some of the plugins will be discussed in detail. + + + + +The <command>abbrev</command> Plugin +abbrev + + +This plugin expands abbreviations into frequently used code snippets. It is +activated by pressing Ctrl +Space. For example, when you enter +"ife" into a C++ in the editor and press +CtrlSpace, you obtain +an if-else code template and save some key strokes. The set +of supported abbreviations depends on the programming language of the edited +file. For example, for PHP you will obviously be interested in other code +templates than for &Java;. + + + + +The set of code templates is configurable. If the plugin is enabled, you can see +which ones are available in the Settings +Configure KDevelop... +dialog under Abbreviations. + + + + + +The <command>filter</command> Plugin +filter + + +This offers two features. If you select Tools +Execute command, you can enter a shell +command. The output of this command is inserted into the editor buffer when +you hit the Start button. + + + + +A related feature is available under +ToolsFilter selection through +command.... In order to use this, you must +select a text area in the editor. If you now enter a shell command and hit +the Start button, the command is started and the +selection used as the standard input for it. The standard output of the +command is then inserted into the editor, replacing the selection. + + + +For example, if you write documentation, you frequently have to refer +to menu items. To do this correctly for e.g. the Copy command in the +Edit menu, you have to write: +<menuchoice><guimenu>Edit</guimenu><guimenuitem>Copy</guimenuitem></menuchoice> +This is cumbersome, so you'd rather just write "Edit - Copy" +and let the computer do the tagging. +Here is how you can do it. +You write a little shell script called mef you put e.g. in your home's bin directory: +sed s/"^\(.*\) - \(.*\)\$"/"<menuchoice><guimenu>\1<\/guimenu><guimenuitem>\2<\/guimenuitem><\/menuchoice>"/ +Don't forget to make it executable. +That's all. Now, in your documentation .docbook source, you write "Edit - Copy". +You select this text you just wrote, choose +ToolsFilter selection through +command... and call ~/bin/mef. +Instantly "Edit - Copy" is replaced by +<menuchoice><guimenu>Edit</guimenu><guimenuitem>Copy</guimenuitem></menuchoice> + + + + + + + +The &doxygen; Plugin +&doxygen; +documentation tool +API documentation + + +This one helps you to use the &doxygen; API documentation tool +(). You can select +Project +Run Doxygen to generate API +documentation for your current project, based on the configuration given by +the file Doxyfile in your project directory. + + + + +Furthermore, you can configure &doxygen; in the +Project +Project options... dialog. This dialog +is very similar to the &doxywizard; tool. + + + + + +The &ctags; Plugin +&ctags; + + +Although the class browser gives you extensive insight into the symbols and +classes of your project, you may also want to use the ctags tool. In particular, +this one supports a lot more language than the class browser. + + + + +You activate this plugin under Tools +CTags.... When you start it the first +time, you will be asked to generate a search database first. When you accept +this, the &ctags; program will be started and will create a file named +tags in your project directory. This is a text file containing +all symbols of your source files. + + + +You can search in the symbol database in two ways: when the +Regular expression match box is checked, the text you +enter will be interpreted as a regular expression (POSIX flavor) and matched +with the existing symbols. For example, the text .*Widget +will search for all symbols ending with Widget. If the +box is not checked, the search will be verbatim. + + + +When searching, you will get a list of the matched symbols, accompanied with +the line numbers where they are defined. You jump to the respective point by +clicking on the list. + + + +For some languages, &ctags; distinguishes different kinds of symbols. For +example, Python has classes and functions. You can selectively search only +for classes by checking the respecting kinds in the dialog. + + + +The symbol database is normally not updated when your sources change. +Consequently, after a while the line numbers will not be correct anymore +and newly added classes and functions will be missing. Therefore you should +update the tags file in regular intervals by pressing +the button Regenerate. + + + + + +The <command>astyle</command> Plugin +astyle +Artistic Style +indentation + + +Astyle is a plugin for formatting of sourcecode according to a specified set of rules. + + + + + + +The <command>regexptest</command> Plugin +regexptest +debuggingregular expressions +regular expressionsdebugging + + +Designing with regular expressions can be hard work. Often the first try at an +expression matches too many strings. In particular, when working with a +compiled language, the turnaround times when debugging a regular expression +can be awkward. The regexptest plugin allows you to directly explore the +changes in a regular expression. It is activated by choosing +Tools +Debug Regular Expression.... + + + + +In the flavor group box, you can choose the flavor of the regular expression +engine used. Currently supported is the flavor defined in the POSIX standard, +which is used by the &grep; program, and the extended POSIX syntax used by the +program &egrep;. + + + +When you enter an expression, you get immediate feedback about any syntax +errors in it. By entering a text under Test string, +you can see whether the expression matches this string. In particular, if +your regular expression includes groups, such as ([a-z]), +the content of the matched subgroups will be shown in a list box. + + + + + + + + + + diff --git a/doc/kdevelop/problem-report-all-todos.png b/doc/kdevelop/problem-report-all-todos.png new file mode 100644 index 00000000..7b2d1b62 Binary files /dev/null and b/doc/kdevelop/problem-report-all-todos.png differ diff --git a/doc/kdevelop/problem-report-marks.png b/doc/kdevelop/problem-report-marks.png new file mode 100644 index 00000000..1e01ebdf Binary files /dev/null and b/doc/kdevelop/problem-report-marks.png differ diff --git a/doc/kdevelop/problem-report-todo.png b/doc/kdevelop/problem-report-todo.png new file mode 100644 index 00000000..56ccbd54 Binary files /dev/null and b/doc/kdevelop/problem-report-todo.png differ diff --git a/doc/kdevelop/project-advanced.docbook b/doc/kdevelop/project-advanced.docbook new file mode 100644 index 00000000..d597e65e --- /dev/null +++ b/doc/kdevelop/project-advanced.docbook @@ -0,0 +1,83 @@ + + + + + BerndPol + + + + +Advanced Project Management + + +Loading Projects + + +Loading a Recently Used Project + + +(... to be written ...) + + + + + + + + + How to open a recent project + + + + + + + + +Loading an Existing Project + + +(... to be written ...) + + + + +Converting Old KDevelop Project Files + + +&kdevelop; allows you to open old KDevelop 2.x project files and convert them to &kdevelop; files. To do so go to Open Project... and select KDevelop 2 project files in the Filter:. Then select project file you want to open. The project gets converted to &kdevelop; and saved as a &kdevelop; project file. + + + + + +Importing an Existing Project + + +To import an existing directory in &kdevelop; select Import Existing Directory +from the Project menu. You should see the Import Directory Wizard, as seen below: + + +
+The Import Directory Dialog + + + +
+ + + + + + + + +Tailoring the Project — Project Options + + +(... to be written ...) + + + + + diff --git a/doc/kdevelop/project-management.docbook b/doc/kdevelop/project-management.docbook new file mode 100644 index 00000000..38a3ff8d --- /dev/null +++ b/doc/kdevelop/project-management.docbook @@ -0,0 +1,751 @@ + + + + + BerndPol + IanWadham + + + + +Building and Project Management + + +This chapter deals only with compiled projects, such as C++, &Java; or +Fortran projects. Projects for scripting languages like Python and +PHP work very differently. + + + +You will find here information on: + + + Summary of &automanag; containing an initial overall view of &automanag;, + + + Automake Manager Operation describing the basics of how to work with &automanag;, + + + + +Summary of &automanag; + + +In the Build systems chapter we have given a rough overview of the build systems commonly in use on &UNIX; systems. In the following sections we will look at this in more detail. + + +There is some confusion about how to name such things. &GNU; calls them build systems when it describes Automake, Autoconf and Libtool. QMake calls itself a tool to write Makefiles for different compilers and platforms. In &kde; often the term project management systems is used. We will use this term in a broader sense to describe the built-in environments in &kdevelop; which are used to organize and build your projects. In the context of this section, however, we will mostly talk about automated build systems. + + + +The Need for an Automated Build System + + +If you have a simple Hello World program, written in C, you can compile and link it using &gcc; -o hello hello.c and execute it using the command ./hello, so you do not even need a Makefile. + + +If you have a C application with several modules and header files and you are only going to run it on your own machine (&ie; it is an in-house application), you will only need a simple Makefile, which is fairly easy to write by hand (use info make to find out more). + + +The complications begin when: + + + + Your source-code, documentation, graphics, sounds, translations, data files, &etc; are located in more than one directory, + + + You have a hierarchy of directories and sub-directories, + + + You are using libraries that are not part of the traditional &UNIX; set, such as the &Qt; Object Library or the &kde; Desktop libraries, + + + You are using a pre-processor to generate some of your source-code, such as Qt's MOC pre-compiler, + + + You aim to distribute your application worldwide, to people who may not have the same &UNIX;/&Linux; system, software and hardware as you, + + + You require an automated Install and Uninstall facility, + + + You aim to make your application part of the &kde; Desktop set. + + + + +If you have some or all of the above situations, you probably need a build system. In the example above we used &gcc; to compile and build the Hello World program, but not all C compilers are called &gcc;. So if you distribute your application to someone who is using some other C compiler, your Makefile must somehow use the name of that person's compiler, otherwise your application will fail to compile—and that is just simple example of what can go wrong. + + +A build system will iron out these differences for you. + + + + It will check that the libraries you need are present on each receiving machine, + + + will automatically scan all your application directories for files to pre-process, compile or install and + + + will install the components of your application in the correct receiving directories, making sure that + + + the directories are created in the receiving machine as required. + + + + +In brief, a build system offers safe and secure methods for your application to be compiled and installed correctly on any receiving machine. As we have shown before in the Project Management Systems survey, &kdevelop; offers three automated build systems and the option of creating your own Makefile, in short (click on the project names to get more information): + + + + Automake projects which use the &GNU; standard development tools. + + + QMake projects which use the trolltech QMake project manager. + + + ANT projects which use the Apache ANT project manager for &Java; development. + + + Custom projects which require you to maintain your own Makefiles. + + + + + +One of these four alternatives must be chosen when you create a project and the choice is difficult to change later, so you should give it some thought before you start. + + + + + + +Tutorials on Autoconf/Automake/Libtool + +There are several tutorials available on the &GNU; Build System (Autoconf, Automake and Libtool) of which the &automanag; makes use. + + + A short autoconf tutorial written by Christopher W. Curtis available on the &kdevelop; home page. It concentrates on some basic steps to modify a Makefile. + + + A more detailed tutorial can be found in a greater set of tutorials on Developing software with GNU. + + + And there is the famous Goat Book, titled Autoconf, Automake, and Libtool. This is an easily readable, yet concise, introduction in all main aspects of the &GNU; Autotools. + + + + + + +What does &automanag; Do? + + +The &appwizard; will have set up some initial Makefile.am files when you created a New Project of a type that uses the &GNU; Build System, such as C++ KDE Application framework. During development &automanag; creates any other Makefile.am files for projects that use the &GNU; Build System and maintains them all, &appwizard; and &automanag; created alike. + + +There will be one Makefile.am file in each directory of your project that contains files to be compiled or installed. It will contain your specifications for compiling, building and installing files and a reference to any subdirectories that also have a Makefile.am file and possibly some files to compile, build and install. + + + +Your project's directories and source files may be structured to any depth, or you may prefer a flat project-structure with all subdirectories at the top level. + + + +The aim of the &GNU; Build System is to produce source-code file structures that can be compiled, built and installed on any &UNIX; or &Linux; system by using the simple commands: + + + +./configure +make +make install # Usually as "root". + + +and can be uninstalled by the command make uninstall (usually as root). + + + +How does this work? Well configure is a script that + + + + works out the details of whatever system it is in, such as what compiler and libraries to use and where they are located, and then + + + creates recursive Makefile files by filling in the substitutions in the corresponding Makefile.in files. + + + + +The Makefile.in are input files—templates which provide basic information for the Makefiles to be produced from them by filling in some system dependent information. They are generated by the Automake utility from the Makefile.am files. + + +The process of going from Makefile.am (.am denotes Automake template files) to Makefile files is handled automatically by the &kdevelop; &promanag;, using the Autoconf utility, M4 macros and other arcana we need not go into here. + + +So when make runs, it automatically picks up the correct pieces from the current environment, such as compilers and libraries. Similarly, make install puts your application components, such as executables, documentation and data files in the correct places for that environment. + + + +If you distribute your application as a tarball (a single compressed file that &kdevelop; can create for you), it will include the Makefile.in files and the configure script file, so the recipient can compile, build and install your application without having Automake, Autoconf or &kdevelop; on their machine. The Makefile.am files are also included, just in case the receiver needs to do any source-code modifications. + + +The rules are rather different if you distribute via a web-based source-code repository such as &kde; &cvs;. + + + + + +Summary of What Automake Manager Does + + + + Generates Makefile.am files in subdirectories it knows as subprojects. + + + Updates Makefile.am files as the project structure changes. + + + Updates Makefile.am files as files are added to or removed from the project. + + + Accepts definitions of how the various files are to be built or installed and modifies the Makefile.am accordingly. + + + Accepts parameters used in building or installing (⪚ library names) and ensures that they are used in the required compilation and build steps. + + + + + + +Contents of Automake Files + + +A Makefile.am file has lines containing variable-names followed by an equals sign and a list of files or parameter values. The variables have two-part names, such as bin_PROGRAMS, myapp_SOURCES or kdelnk_DATA. The second part is called the primary and represents something from which to build or install. The first part is called the prefix and represents: + + + + A directory in which to do installation (⪚ bin), + + + A qualifier for the primary (⪚ myapp for SOURCES, indicating that the source files listed after myapp_SOURCES go into building myapp), + + + A special prefix noinst (short for no installation), usually used to list program header files (.h), + + + Or the special prefix EXTRA, for configuration-dependent stuff. + + + + +For more information on Automake and Makefile.am files, look up info Automake. + + +Basically, &automanag; creates and updates the variable-names and lists of files or parameters. See the following example of a Makefile.am for a typical application, called myapp. + + + +## Makefile.am for myapp + +# this is the program that gets installed. it's name is used for all +# of the other Makefile.am variables +bin_PROGRAMS = myapp + +# set the include path for X, qt and KDE +INCLUDES = $(all_includes) + +# the library search path. +myapp_LDFLAGS = $(KDE_RPATH) $(all_libraries) + +# the libraries to link against. +myapp_LDADD = $(LIB_KFILE) $(LIB_KDEPRINT) + +# which sources should be compiled for myapp +myapp_SOURCES = main.cpp myapp.cpp myappview.cpp + +# these are the headers for your project +noinst_HEADERS = myapp.h myappview.h + +# let automoc handle all of the meta source files (moc) +METASOURCES = AUTO + +KDE_ICON = myapp + +# this is where the kdelnk file will go +kdelnkdir = $(kde_appsdir)/Utilities +kdelnk_DATA = myapp.desktop + +# this is where the XML-GUI resource file goes +rcdir = $(kde_datadir)/myapp +rc_DATA = myappui.rc + +AM_CXXFLAGS = -DMY_C++_PREPROCESSOR_OPTION + + + +As you can see, many of the items on the right hand side are symbols of the form $(xxx). These are environment variables which are defined in the actual &kde; environment and are substituted with real values when ./configure generates the final Makefile files in the receiving machine. + + + +Also, sometime after you have started with &kdevelop;, it is a good idea to run the command ./configure --help, which will show you the range of things you can change at build and installation time, such as for a test environment. In particular, the command: + + +./configure --prefix=/where/you/wish + +will re-direct the entire installation to a directory structure of your choice, by changing the internal variable $(prefix) to value /where/you/wish. + + + + + + + + + +Automake Manager Operation + + +In this chapter you will find a basic description of the &automanag; elements and how to use them. This covers: + + + The &automanag; Window describes the basic structure of the &automanag; main window. + + + The Overall View Window describes the elements of the upper subwindow. + + + The Detail View Window describes the elements of the lower subwindow. + + + Navigating in the &automanag; lists some basic operations you can perform in the &automanag;. + + + Popup Menus in the &automanag; describes the windows which will pop up when you select an action in the &automanag;. + + + + + +The &automanag; Window + + + + + + + + + + + &automanag; runs in a split window. The top part is called the Overall View and the bottom part is called the Detail View. Between them is a narrow bar that can be dragged with the mouse to adjust the sizes of the views. In IDEAl mode you can also drag the side of the split window to change the width. + + + On top of each view there is a toolbar, the buttons in which will become activated when an element in this view is selected. This provides one way you can access the actions provided for that view element. The other are context menus which pop up on right mouse button click as will be discussed below. + + + In IDEAl mode there are two additional small buttons in the &automanag; window titlebar left hand side – a triangular shaped right arrow, and a dot button. The arrow button is used to close the window. The dot button on the other hand will keep the window open even if another &kdevelop; window has been selected. (Otherwise the &automanag; window will automatically close whenever another window gets the input focus.) + + + + + + + + +The Overall View Window + + +The overall view window contains a tree-list of all the directories in your project that contain program files, documentation or data. Each such directory contains a Makefile.am file and is known in &automanag; as a subproject. There are three typical subprojects in a &kde;-based project as shown in the above illustration: + + + + + src – source-code files for your application, + + + doc – your user manual or Handbook, + + + po – extracts of strings in your source-code files that require translation into other human languages (⪚ window titles, menu names, button labels, dialog box text and messages of various kinds). + + + + +Note that the doc subproject always has an en subproject, which you can see if you click on the + symbol next to the word doc. That is because the base language of all documentation in &kde; is United States English (en). If your application becomes part of &kde;, the &kde; translation teams may translate your documentation from United States English into other languages and the translations will go into other subprojects, such as de (German) or fr (French). The strings in the po subproject may also be translated and stored in other files in po, thus allowing your application to be operated by people who do not know English. + + + +The doc and po subprojects serve different purposes. doc contains documentation like a user manual, po contains translatable text strings of the user interface which is integrated in the source code of this application. + + + +The overall view window serves—amongst other things—as a navigation tool. If you select a subproject in the overall view window, the corresponding details will be shown in the detail view window. + + + + + +The Detail View Window + + +The detail view contains a tree-list of all the files in the subproject currently selected in the overall view as well as the compilation, build and installation rules for this subproject. Thus the two views together can give you access to all the components of your application and all the information on how to compile, build and install it. + + + +Targets + +The tree-list in the detail view has two levels. The top level consists of so-called &automanag; targets and the next level contains lists of files that go to make up each target. + + + +This concept of an &automanag; target differs somewhat from what a Makefile target usually is. In short: + + + The definition of how a set of files is to be compiled, built or installed is known as a target in &automanag;, but as a variable in Automake itself. + + + A target in make is often something quite different, being the parameter of a make command (⪚ make install, make clean). + + + However some Makefile.am variables do represent an underlying sub-target in make. + + + + + + + +Navigating in the &automanag; + + +In both the overall and the detail view you can left-click on the + or - next to a subproject or target name to expand or contract the tree view. If you do that with a subproject in the overall view, it shows or hides the subprojects at the next level down (if any). If you do it with a target in the detail view, it shows or hides the list of files that go into that target. + + + + +Opening a file for Edit + +If you &LMB; click on a file name in the detail +view, the corresponding file opens up in &kdevelop;'s editing window. + + + + +Activating the &automanag; Toolbar Buttons + + +If you &LMB; click on the name of a subproject in the +overall view or target in the detail view, the name is highlighted and some +toolbar buttons become active in the top part of that view. + + + + It is recommended that you use the right mouse-button and popup menus, rather than the toolbar buttons, because it is then much easier to see and understand what you are doing. + + + Operations on subprojects and targets have far-reaching effects on the structure, compilation, building and installation of your application. + + + + + + +Selecting Actions/Popup Menus + + +If you &RMB; click on the name of a subproject, target or file, a menu pops up and you can then select actions to perform on the subproject, target or file, such as add a target to the subproject, add a file to a target or logically remove the selected file from its target. + + + + + + + + +Popup Menus in the &automanag; + + +The following sections explain in short terms which operations the menus make available which will pop up on right mouse button clicks in the &automanag; window. They are meant for overall view only. You will find detailed descriptions of most operations in a later chapter. + + + + +The Popup Menu for a File + + +When you &RMB; click on a file name in the detail view the following menu will pop up allowing you to select one of several operations to be performed on that file. In the illustration below the hi-16app-myapp.png icon file was selected from the Icon data in myapp target of the myapp/src subproject. + + + + + + + + + + + + The main popup-menu item for a file is to Remove the file from its target (&ie; it will no longer be used to compile, build or install that target). + + + The CVS item offers a variety of CVS operations on the file. + + + The Open With item allows you to open the file with a variety of editors or with any application at all (⪚ you can open the icon file in our example with KIcon). + + + The Perforce item is used for similar operations as in CVS using the commercial Perforce version control system. + + + + + + + + +The Popup Menu for a Target + + +When you right-click on a target in the detail view the following menu will pop up allowing you to select one of several operations to be performed on it. In the illustration below the myapp (Program in bin) target of the myapp/src subproject was selected. + + + + + + + + + + + + The Options item for a target only applies to source code files. In the corresponding dialog box you can specify linker flags and paths on which to locate libraries and you can give a list of actual libraries to be linked in to your application. + + + The Create New File item brings up a dialog in which you can set the file name and the type of file to be generated (from a drop-down list). + + + The Add Existing Files item brings up a dialog box in which you can add an already existing file to this target. + + + The Remove item for a target allows you to logically remove the target and all its files from the project structure. + + + The Make Target Active item only applies to targets containing source code files. New files will always be added to such an active target. + + + The Build Target item calls all necessary compile and make operations to build the code for this target only. + + + + + + + + +The Popup Menu for a Subproject + + +When you &RMB; click on a subproject in the overall view window the following menu will pop up which allows you to make major changes to the structure of your project and the way it is compiled, built and installed. You can use it to expand or modify the basic project structure that the &appwizard; has created. + + + + + + + + + + + + + The Options item for a subproject controls the way that the subproject will be compiled, built and installed. The dialog box that pops up has tabs for Compiler, Includes, Prefixes and Build Order. + + + The Add Subproject item creates a new directory and skeleton Makefile.am file. + + + The Add Target item pops up a dialog in which you can set the rules for compiling, building or installing a group of files within your subproject. + + + Add Service (... to be written ...) + + + Add Application (... to be written ...) + + + Add Existing Subprojects (... to be written ...) + + + The Remove Subproject item in the popup menu for a subproject is the proper way to remove a subproject. It will adjust the Makefile.am files accordingly. You will also be offered the option to delete all the files (or links) in the corresponding subdirectory. Obviously, this feature should be used with caution. + + + The Build item calls all necessary compile and make operations to build the code for this subproject only. + + + Force Reedit (... to be written ...) + + + Clean (... to be written ...) + + + Install (... to be written ...) + + + Install (as root user) (... to be written ...) + + + + + + + + + + + + + + +Automake Projects +autoproject +&automake; +&autoconf; +&libtool; + + +(... to be written ...) + + + + +Autoconf +configure script +config.status script +Makefile.in +config.h.in + + +Makefile.in into Makefile + + + +prefix = @prefix@ +INSTALL = @INSTALL@ +build_triplet = @build@ +CXX = @CXX@ + + + +prefix = /home/bernd/kde3 +INSTALL = /usr/bin/ginstall -c -p +build_triplet = i686-pc-linux-gnu +CXX = g++ + + + +config.h.in into config.h + + + +/* Define if you have libz */ +#undef HAVE_LIBZ +/* The size of a `int', as computed by sizeof. */ +#undef SIZEOF_INT + + + +/* Define if you have libz */ +#define HAVE_LIBZ 1 +/* The size of a `int', as computed by sizeof. */ +#define SIZEOF_INT 4 + + + + + + +Automake + + +(... to be written ...) + + + + + + +&kdevelop;'s &automanag; + +
+A screenshot of the automake manager + + + +
+ + + + + +Building and Installing Libraries + + + + + -rpath + + + PIC + + + static + + + plugins: no-undefined + + + + + + + + + + + +Custom Makefiles and Build Scripts +Makefile +build.xml + + +(... to be written ...) + + + + + + + +Compiler Options + + +(... to be written ...) + + + + + + + +Make Options + + +(... to be written ...) + + + + + diff --git a/doc/kdevelop/raw-project-warning.png b/doc/kdevelop/raw-project-warning.png new file mode 100644 index 00000000..c9065815 Binary files /dev/null and b/doc/kdevelop/raw-project-warning.png differ diff --git a/doc/kdevelop/run-button.png b/doc/kdevelop/run-button.png new file mode 100644 index 00000000..51522e90 Binary files /dev/null and b/doc/kdevelop/run-button.png differ diff --git a/doc/kdevelop/script_location.png b/doc/kdevelop/script_location.png new file mode 100644 index 00000000..e5488024 Binary files /dev/null and b/doc/kdevelop/script_location.png differ diff --git a/doc/kdevelop/select-user-interface-0.png b/doc/kdevelop/select-user-interface-0.png new file mode 100644 index 00000000..c98faf71 Binary files /dev/null and b/doc/kdevelop/select-user-interface-0.png differ diff --git a/doc/kdevelop/select-user-interface.png b/doc/kdevelop/select-user-interface.png new file mode 100644 index 00000000..927ad411 Binary files /dev/null and b/doc/kdevelop/select-user-interface.png differ diff --git a/doc/kdevelop/setup.docbook b/doc/kdevelop/setup.docbook new file mode 100644 index 00000000..e5449a99 --- /dev/null +++ b/doc/kdevelop/setup.docbook @@ -0,0 +1,1990 @@ + + + + + BerndPol + + + + +Configuring &kdevelop; + + +&kdevelop; is a very powerful and flexible IDE which offers many ways to tailor it to your needs. To start configuration select SettingsConfigure &kdevelop;.... This will cause the configuration dialog to pop up consisting of a selection window to the left and the configuration dialog on the right hand side whose contents will vary upon the configuration item you did select. + + + + + + + + +Select a configuration item + + + Select a configuration item + + + + + +We will discuss these configurations in a different order, split up into the main topics of General Configuration, Configuring the Documentation, and Advanced Configuration which makes for a more intuitive reading. + + +If you want directly look up a certain configuration item use one of the following links. + + + + General + User Interface + File Templates +Editor + Abbreviations + Scripting + Tools Menu + External Tools + Documentation + Code Snippets + File List + File Selector + C++ Class generator + Formatting + C++ Parsing + + + +General Configuration + + +General configuration concerns the more common tasks of tailoring &kdevelop; as there are: + + + + General Setup + + + Selecting the User Interface + + + +Source Edit Tasks + + Selecting an Editor + + + Selecting a Source Format Style + + + Setting Up the Code Snippets Tool + + + + + Configuring the File Selector + + + + +General Setup + + +The General configuration dialog allows you to define some basic &kdevelop; behaviour which seldom will change in everyday work. This concerns: + + + + +General project options such as + + + + defining a default parent directory &kdevelop; shall use for new projects. + + + deciding whether you want &kdevelop; to automatically load the project you last worked on. + + + + + + +Selecting a font for the most commonly used output view windows, +namely: + + + + +the Messages Output +View &kdevelop; uses to communicate ⪚ compilation progresses, +and + + +the Application Output +View which will show error and state information concerning a running +application. + + + + + + + +Some common behaviour concerning the displayed lines in the +Messages Output View window, namely: + + + +whether long lines will wrap + around, and + + +if directory entry and exit +messages issued by make will be shown. + + + +The level of detail of + messages concerning the compilation process shown in the + Messages Output View window. + + + + + + + + + + + The general configuration dialog + + + + + + +Load last project on +startup + + +Mark this checkbox if you want to continue to work with the last project you worked on. This will cause &kdevelop; to automatically load this project on start-up. It will usually be shown in the state you left work so you can readily proceed. + + + + + + +Default projects directory: + + +By default, &kdevelop; uses a common parent directory for all new +projects. Enter the absolute path of this common directory in the box or +select it from your directory structure. &kdevelop; will place the any new +project here as a subdirectory. + +You may of course change the directory path of a new project at the time you set it up in the &appwizard;. + + + + + +Window font: + + +The Application Output View window is used to display error and state information from applications which are run from inside &kdevelop;. These are informations the applications usually sends to the console when run stand-alone. So you do not need to leave the IDE when testing the application you currently work on. + + +To select a font suitable for the Messages Output View window click the Window Font button showing the currently selected font (it says Luxi Sans in the above illustration). The &kde; standard Select Font dialog will pop up from which you may select the font to be used. + + +On first start-up, &kdevelop; initializes this font setting to the standard font for which your &kde; user has been configured. This setting is fixed, so if you alter PreferencesAppearances & ThemesFonts in the Control Center, this will not effect this &kdevelop; font selection. You will have to explicitely reselect the Messages Output View window font. + + + + + +Compiler Output + + +&kdevelop; preprocesses the messages the Messages Output View window receives during the build processes in order to filter superfluous information. You can control the level of detail &kdevelop; will display using the dropdown box in this field. + + + +Very Short + +Displays only warnings, errors, and the filenames which are compiled. + + + +Short + +Suppresses all compiler flags and formats the output to be more readable. + + + +Full + +Displays all output messages unmodified. + + + + + +There is an alternative way to switch the compiler output detail. Just right click in the Messages Output View window and select the according detail level from the popup menu. + + + + + +Line wrapping + + +By default, &kdevelop; will wrap long lines around in the Messages Output View window so that valuable information will not be easily overlooked. In some cases this will clutter long message lists. Remove the checkbox mark if you do not want the lines wrap around. + + +There is an alternative way to switch the line wrapping. Just &RMB; click in the Messages Output View window and mark/unmark the Line Wrapping entry in the menu which will pop up. + + + + + +Directory navigation +messages + + +The make tool usually will display messages like Entering directory, or Leaving directory when it switches the directories it currently works in. As this clutters the messages list in the Messages Output View window, &kdevelop; suppresses those messages by default. Mark the checkbox if you want to protocol which directories make worked in. + + +Changes in this setting effect the processing of new messages only. Old directory navigation messages will be kept visible when you switch this feature off. + + + + + +UI Designer Integration + + +This let you choose the way you want .ui files to be displayed in &kdevelop;. &kdevelop; comes with its own UI designer called KDeveDesigner that can either be embedded or be run as a separate program. Qt Designer can also be used to edit .ui files. + + + + Use &kdevelop;'s embedded designer + This uses &kdevelop; own designer embedded within &kdevelop; + + Run &kdevelop;'s designer as a separate application + The KDevDesigner application will be run separately in its own window. + + + + + + + KDevDesigner in its own window + + + + + +Run Qt Designer + Qt Designer from your Qt installation will be started externally whenever you click on a .ui file in &kdevelop;. + + + + + +Terminal Emulation + + +You choose here which terminal you want to be integrated within KDevelop. + + + + Use &kde; setting + This uses &kde; setting as set in &kcontrol; in &kde; component Component Chooser tab which sets the default terminal emulator used by all &kde; applications that need a terminal. + + Other + Choose some other terminal different from the default one. + + + + + + + + + + +Selecting the User Interface + + + user interface + switch modes + + switch UI modes + + +As already said in the Available User Interface Modes chapter there are five different ways the &kdevelop; work area may be set up, namely: + + + + Simplified IDEAl window mode + This is a simplified version of the IDEA user interface. It is designed to be simple and clean. It also does not uses docked toolviews. + + IDEAl window mode + This is a clone of the IDEA user interface, similar to the Tabbed pages mode and is default. + + Childframe window mode + All tool views are initially docked to the mainframe. +Editor and browser views will live like toplevel windows within a view area of the mainframe. +A typical example of this user interface mode is MS Visual Studio 6.0. + + Tabbed pages mode + All tool views are initially docked to the mainframe. +Editor and browser views will be stacked in a tab window. +A typical example of this user interface mode is KDEStudio, our friend C++-IDE in the world of KDE. + + Toplevel window mode + All editor, browser and tool views will be toplevel windows (directly on desktop). +The main widget contains the menu, toolbars and statusbar only. +A typical example of this user interface mode is Borland Delphi 6.0. + + + +To switch the user interface mode select Settings Configure &kdevelop;... from the menus. The Customize KDevelop dialog will pop up, where you have to select User Interface in the left hand tree. This will display the following settings dialog to the right. + + + + + + +Select a user interface mode + + Select a user interface mode + + + + + +Select the radio button of the user interface mode you want to switch to, then click OK. + + + +Do not forget to restart &kdevelop; in order to let any of these selections take effect. + + + +When you selected either the Simplified IDEAl window mode or the IDEAl window mode or the Tabbed pages mode two more configuration sections will become available: Use Tabs and Use Close On Hover. These allow to configure under which circumstances tabs will be shown on top of the document windows and whether you may close the document by a click on the tab icon. + + + +In Simplified IDEAl window mode and in IDEAl window mode only yet another configuration section will be available, Toolview Tab Layout which effectively allows to select between different sizes of the toolview tabs which surround the main working area in this mode. + + + + +Configuring the Documents Tab Bar Display + + +In the IDEAl and tabbed pages modes there will be named tabs on top of the document windows by default, so you can easily select different documents with a &LMB; click. If you prefer to provide more space for the document windows in the &kdevelop; main work area, you may change to another behaviour in the Use Tabs configuration section. + + + + + Always + + This is the default — show a tab comprising an icon and the document name on top of any document window in the &kdevelop; main area display. + + + + When more than one + + Do not show a tab when only one document is displayed. If there is more than one document, however, &kdevelop; will display an according tab bar as in the Always selection above. You may want to select this mode if you work on a single document most of the time as this provides more vertical space. + + + + Never + + Never show any document selection tab. You may prefer this mode if you seldom use the mouse to switch between documents. It provides more vertical space for all document windows. To select another the document window or to close any, use the &kdevelop; Window menu. + + + + + + + +Setting Up to Close a Document by a Click On Its +Tab + + +When you configured &kdevelop; to display the documents tab bar, either always or when more than one document is displayed in the main work area, you may add more functionality to the tabs beyond their document selection capability. Use the Use Close On Hover coniguration section for this. + + + + + No + + This is standard behaviour. No extra functionality is added to the tabs. They may be used only to select document windows on &LMB; clicks. + + + + Yes + + When you selected this radio button, &kdevelop; will allow to close a document window by a &LMB; click. Use the mouse to point at the small icon on the on the left tab border. It will change to a close symbol. Now click with the &LMB; on this changed symbol and &kdevelop; will close the according document window. + + + + Yes, Delayed + + After selecting this radio button, &kdevelop; will allow to close a document window as shown in the Yes case above. The icon will not change instantly, however, but there will be a short delay before the close icon shows up. + + + + + + + +Configuring the Toolview Tab Layout + + +The Toolview Tab Layout configuration section will be available in IDEAl mode only. Use these radio buttons to set up the look of the toolview tabs which surround the main working area in this mode. + + + + + Icons + + + Each tab will show an icon only. If the associated toolview is displayed, the tab will open and a descriptive text for this toolview be shown. You may want to use this mode if you work on a monitor with limited resolution. + + + The icons are not very descriptive, however. If you want to find out which toolview is assigned to a given tab, point at it with the mouse and wait a second. A short tooltip will then pop up with the toolview name. + + + + + Text + + This is the default toolview tab display mode. Each tab displays the name of its associated toolwiew. + + + + Text and Icons + + If the standard text toolview display looks too flat to you and you are working on a high-resolution monitor you may want to select this radio button. It will cause the name of the associated toolview be displayed on each tab plus an icon to the left of it, making the tabs easier to distinguish. See the Folded Toolview Tabs illustration below for an example. + + + + + + + +Folded Toolview Tabs + + +If you selected the IDEAl mode toolview tabs to display texts (with or without accompanying icons) you need not worry about them being hidden behind some toolview window. If one of the bottom toolview windows occupies more space than is available to display all (vertical) tabs, they will fold around as this illustration shows: + + + + + + + +Toolview tabs fold to not be hidden behind another view window + + Toolview tabs fold to not be hidden behind another view window + + + + + +The active toolview window must be shown fixed (non-overlap mode), sharing the work area with the other windows, to force such tab folding. Press the small square in the window border to accomplish this as shown in the example. + + + + + + + + +File Templates + + + + + + + +Configure File Templates + + Configure File Templates + + + + + + +Selecting an Editor + +&kdevelop; allows you to select your favorite text editor tool. Mark the Editor entry in the left hand side selections tree of the Configure KDevelop window. The following dialog will be displayed to the right. + + + + + + + +Select an editor + + Select an editor + + + + + +To select a new editor, click on the arrow on the drop down list field. Depending on the editor parts interfaces your &kde; version has compiled in you will be provided with a list of editors you may select from (see the Important note below for this). Click on the editor of your liking and click OK. Currently there are two possibilities: + + + + + Embedded Advanced Text Editor + + This is the &kde; standard Kate editor part. + + + + + Qt Designer Based Text Editor + + This is the editor &Qt; provides in its Designer component. + + + + + +These editor interfaces are fully integrated in the &kdevelop; IDE concept. Particularly the possibility to jump to the offending source code line by just clicking on an error message in the Messages Output View window has been provided. + + + +Changing the editor will not effect already open files. There are two possibilities to proceed. Either close all open text windows and reopen them one by one. Or simply close the whole project and reopen it again. The windows will then automatically open under the new text editor interface. + + + +KDevelop lets you use editor interfaces which have registered with &kde; and that provide a KatePart interface. If you miss one one of the selections shown above check your &kde; installation if the corresponding KPart was correctly installed. + + +What to do if the file has been changed externally: + + + Do nothing + + The file will be marked as externally changed and the user will be asked to verify any attempt to overwrite it. + + + + Alert the user + + A dialog will alert the user that a file has changed and offer the user to reload the file. + + + + Automatically reload the file if safe, alert the user if not + + Any files that are not modified in memory are reloaded and an alert is shown for any conflicts. + + + + + + +Abbreviations for the Word Completion + + +(... to be written ...) + + + + +Scripting + + +(... to be written ...) + + + + +Adding &kde; Standard Applications to the Tools Menu + + +(... to be written ...) + + + + +Adding External Applications to Menus + + +(... to be written ...) + + + +Adding to the Tools Menu + + +(... to be written ...) + + + + +Adding to the File Context Menu + + +(... to be written ...) + + + + +Adding to the Directory Context Menu + + +(... to be written ...) + + + + + + +Selecting a Source Format Style + + +&kdevelop; automatically formats a source text in a predefined style. This style is highly configurable. + + + +The reformat source feature is currently available for C, C++, and &Java; only. Especially you cannot use it for scripting languages like ⪚ PHP. This is because &kdevelop; uses the astyle application to implement this feature. + + + +To set up a specific format style, select Settings Configure &kdevelop;.. from the menubar. The Customize KDevelop dialog will pop up, where you have to select Source Formatter in the left hand tree. This will display a series of three settings dialog tabs to the right, namely a General Formatting Setup, a Indentation Style Setup, and a Other Formatting Setup. + + + +Any style changes apply to newly entered text only. If you want to change the formatting style of an already existing source text you will have to explicitely use the EditReformat Source command. + + + +The exact outcome of these style formatting definitions depends on the editor you use. Currently, most settings are tailored to the Kate editor part (the Embedded Advanced Text Editor). Some other editors (⪚ the Qt editor) may rely on their own configuration settings. You will have to experiment in this case to find out the exact effects of the style settings provided here. + + + +There may be incompatibilities between the configuration style settings provided here and the editor you use up to the extent that in extreme cases it even might destroy your files. Make sure you have a backup of your source files before you try out these settings with an none KDE standard editor. + + + +General Formatting Setup + + +The General tab of the Source Formatter dialog allows you to select one out of five predefined source format styles. + + + + + + + +Source format style general setup + + Source format style general setup + + + + + +A formatted source example will be displayed in the field to the right. If none of the predefined styles is to your liking, you may click the top User defined radio button and define your own source formatting style preferences on the other two tabs which will become available then. + + + +Currently only the predefined source formatting styles will be demonstrated by an example text. If you decide to define your own style, no example display will be available. You have to experiment on an actual source text to tailor the settings to your liking. + + + + + +Indentation Style Setup + + +Proper indentation is the main means to enhance readability of a source text. I you selected the Indentation tab of the Source Formatter dialog you will be presented with a series of indentation formatting choices grouped into three boxes as following. + + + + + + + +Source format indentation style setup + + Source format indentation style setup + + + + + + +Default Settings + +The preset format choices will cause the source text to resemble the +ANSI formatting style: + + +namespace foospace +{ + int Foo() + { + if (isBar) + { + bar(); + return 1; + } + else + return 0; + } +} + + + + + +Defining Indentation Width and Characters + +The radio buttons grouped in the Filling group +define how indents in the source text will be drawn. + + + + Use tabs + + + This will cause the editor to insert a tab character for each +indentation level. The tab width is predefined in the editor settings (8 or +4 character columns usually). Use SettingsConfigure Editor... to redefine it. + + + The actual tab width definition procedure depends on the editor you selected in the Selecting an Editor configuration step. You will have to look up the corresponding editor help to find out. + + + + + Use spaces + + If you select this radio button, the editor will enter a number of spaces for each indentation level. Change the number from the default 2 to the indentation width you prefer. + + + + + + + +Indented Entities + +This defines which of the (C/C++) entities will be formatted with an +extra indent beyond the current indentation level. + +By default only namespaces and +labels will be extra indented. You may want to +experiment with various settings to tailor those extra indents to your +liking. + + + + +Continuation + + +The settings grouped here apply to those cases where the source formatter automatically wraps around long source lines. It takes two special cases in account, namely that in deeply nested indents there should remain enough room for the source and that conditionals should get extra indent levels on continuation to make them stand out properly. + + + +This applies to static word wrap cases only where a fixed maximum line width is used in the source text. If you set up your editor to dynamically wrap around long lines in display only (which is possible in the &kate; editor part) the effects of these settings usually will not show. + + + + + Maximum in statement + + + This setting limits the maximum possible indentation for the continuation lines so that enough space will remain to keep the text readable. No continuation line will ever be indented beyond the number of columns you selected in this field. + + + The default is set to 40 character columns (half a standard 80 column page). You may want to increase this value to account for wider paper (e.g if you use landscape printing for your sources). Or decrease the value accordingly to take larger margin settings of your printouts into account. + + + + + Minimum in conditional + + + Conditionals or source following ⪚ an assignment operator should usually get an extra indent on continuation lines in order to keep the text readable. The amount of this extra indent is defined here. + + + The default is set to Twice current which means that continued conditionals will get an extra indent level of the standard indentation size you selected in the Filling group. You may change this extra indent to another fixed width (including zero) using the arrows or by entering the value directly. + + + + + + + + + + + +Other Formatting Setup + + + + + + +Other source format style settings + + Other source format style settings + + + + + + +Controlling the position of braces + +The radio buttons the (somewhat misnamed) +Brackets group control the position of block delimiting +braces in a (C/C++) source text. There are three possibilities from which +you can select. + + + + Break + + This inserts a line break before each opening brace. Both delimiting braces of any block will be put at the same indentation level as the block head statement. + + +namespace foospace +{ + int Foo() + { + if (isBar) + { + bar(); + return 1; + } + else + return 0; + } +} + + + + + Attach + + + This will keep the opening brace of a block in line with the block head statement. Closing braces will be on the same indentation level as the block head statement. The else of an if statement will be kept in line with the closing brace of the preceding block. + + +namespace foospace { + int Foo() { + if (isBar) { + bar(); + return 1; + } else + return 0; + } +} + + + + + Linux Style + + + This is a compromise of the above listed styles. Functional block delimiting braces will be put on extra lines. Braces opening a block in a conditional or loop statement will be kept in line. + + +namespace foospace +{ + int Foo() + { + if (isBar) { + bar(); + return 1; + } else + return 0; + } +} + + + + + + + + +Controlling Extra Spaces + + +By default &kdevelop; does minimize the use of spaces in source texts. + + + + +if (isBar(fooArg)==barValue) + + +You may enhance readability if you force the source formatter to +insert extra spaces in special positions. + + + + Add spaces around parentheses + + In fact what is meant is to add spaces around the text put in parentheses. This enhances the readabilitiy of function arguments and conditionals. + +if ( isBar( fooArg )==barValue ) + + + + + Add spaces around operators + + This will put spaces around assignment and comparison operators to enhance the readability. + +if (isBar(fooArg) == barValue) + + + + + + + + +Controlling the formatting of one-line constructs + +There are a few cases where you don't want the source formatter to +split a long line apart. For C/C++ code this can be controlled here. + + + + Keep one-line statements + + This keeps single line statements together in some situations even if they exceed a fixed maximum line length. + + + + Keep one-line blocks + + This keeps single line blocks together in some situations even if they exceed a fixed maximum line length. + + + + + + + + + + + + + +Setting Up the Code Snippets Tool + + +When editing in &kdevelop; you can store often used parts of code as Code Snippets. To configure the capabilities of the code snippets part select Settings Configure &kdevelop;.. from the menubar. The Customize KDevelop dialog will pop up, where you have to select Code Snippets in the left hand tree. This will show the following dialog in the right hand side. + + + + + + + +Configuring the code snippets tool + + Configuring the Code Snippets tool + + + + + + +Activate Snippet Preview + +Mark the Show snippet's text in tooltip checkbox +if you want to view the stored text in a tooltip window whenever you keep +the mouse cursor over the title of that snippet. + + + + +Working with Snippet Variables + +The Code Snippets tool allows for a variable text +in predefined places any time you insert a snippet into a file. To +accomplish this Code Snippets provides its own +variables' mechanism. You can set up it's behaviour in the +Variables group. + + + + Delimiter + + The Code Snippets tool distinguishes variables in the text by surrounding the variable name with special delimiter symbols. To use your own delimiter symbol, change the predefined $ character in the Delimiter field. + + + + Input method for variables + + + Single dialog for each variable within a snippet – will in turn pop up a separate dialog for each variable which the tool finds when inserting the selected code snippet. + + + One dialog for all variables within a snippet – will pop up a common dialog where the user has to fill in the values of all variables before the snippet will be inserted + + + + + + + + + + + +File List + + +(... to be written ...) + + + + + +Configuring the File Selector + + +&kdevelop; provides a File Selector plugin which, when +loaded at start-up, allows to navigate to any file or directory in the +system. + + + + + + + +The file selector in IDEAl mode + + The file selector (IDEAl mode) + + + + +The behaviour of the File Selector can be highly +configured. Select Settings +Configure &kdevelop;.. from the +menubar. The Customize KDevelop dialog will pop up, +where you have to select File Selector in the left hand +tree. This will show the following dialog in the right hand side. + + + + + + + +Configuring the file selector + + Configuring the file selector + + + + + + +Configuring the Toolbar + +There is a toolbar on top of the File Selector +which can be configured as usual in the Toolbar +group. + + + Add an Action to the Toolbar + + + Select an item in the right hand Selected actions list after which the new action should be inserted. + + + + + Select the action to be inserted in the left hand Available actions list. + + + + + Click the right (upper) arrow between both lists. + + The action will be removed from the Available actions list and inserted into the Selected actions list below the selected item. + + + + + + Remove an Action from the Toolbar + + + Select the item to be removed in the right hand Selected actions list. + + + + + Click the left (lower) arrow between both lists. + + The selected item will be removed from the Selected actions list and put back into the Available actions list. + + + + + + Reorder the Actions on the Toolbar + + + Select the action to be moved in the right hand Selected actions list. + + + + + Click the up or down arrow to the right of this list. + + The selected item will be moved up or down the Selected actions list. + + + + + + + +Defining When the Contents Should +Change + + +Updating the contents in the File Selector window takes time and resources, esp. when changing to another directory. Therefore File Selector is set up by default in such a way that its contents change only on demand, &ie; when you select another directory or when you explicitely want to refresh its contents. + + + +Click the Reload button in the toolbar to update the contents of the File Selector. This toolbar button is not available by default, however. You must insert it there first. + + + +You can configure the File Selector to immediately reflect certain changes in your work. The settings in the Auto Synchronization group of the configuration dialog are responsible for this. + + + + + When a document becomes active + + If you select this checkbox, the contents in the File Selector window will be updated whenever you go to another already open document, ⪚ when you click on the tab of the according edit window in IDEAl mode. If necessary the File Selector will switch to the directory this file belongs to and update the display to show the actual contents in there. + + + + When a document is opened + + If you select this checkbox, the contents in the File Selector window will be updated whenever a document will be opened, ⪚ by the FileOpen menu. If necessary the File Selector will switch to the directory this file belongs to and update the display to show the actual contents in there. + + + + When the file selector becomes visible + + If you select this checkbox, the contents in the File Selector window will be updated whenever it gets visible again. If necessary it will switch to the directory the actual document belongs to and update the display to show the actual contents in there. + + + + + +You may freely combine these settings to tailor the actualization behaviour of the File Selector to your liking. + + + + + +Controlling the History in the Comboboxes + +There are two comboboxes on top and bottom of the File +Selector contents window which control the directory to be +displayed (top combobox) and the filters to be applied to the file display +(bottom combobox). A history of the most recent settings is kept in the +selection field of each combobox. You can configure the number of history +entries as follows. + + + + Remember locations + + Enter here the maximum number of directory selections the upper combobox shall remember. + + + + Remember filters + + Enter here the maximum number of filter definitions the lower combobox shall remember. + + + + +Controlling What Should be Remembered Between Sessions + + +By default the File Selector is set up so that it shows the display of the most recent session again at the next &kdevelop; start-up. You may change this behaviour in the Session configuration group. + + + +If &kdevelop; was automatically restarted by the &kde; session manager the changes in these settings will have no effect. In this case location and filter settings of the most recent &kde; session will always be restored. + + + + + + Restore location + + + Remove the checkbox mark here if you don't want the displayed location be remembered between sessions. + + + If you selected one of the automatic update settings the displayed location might automatically change regardless what has been remembered from the recent session. + + + + + Restore filters + + + Remove the checkbox mark here if you don't want the filters applied to the display be remembered between sessions. + + + + + + + + + + + +C++ Class Generator + + +(... to be written ...) + + + + + +Formatting + + +(... to be written ...) + + + + + +C++ Parsing + + +(... to be written ...) + + + + + + + + + +Configuring the Documentation + + +&kdevelop; contains a very powerful documentation facility which provides access to several kinds of extensive documentation. In ⪚ IDEAl mode you find a Documentation tab at the right border of the work area. + + + + + + + +The &kdevelop; documentation window in IDEAl mode + + The &kdevelop; documentation window (IDEAl mode) + + + + + +&kdevelop; must have loaded the Documentation plugin in order to view the documentation tree. See the Plugin Tools section for more info. + + + +You may set up contents and behaviour of the various parts of this documentation window if you select Settings Configure &kdevelop;.. from the menubar. The Customize KDevelop dialog will pop up, where you have to select Documentation in the left hand window. + + + +The thus displayed configuration page shows three tabbed configuration dialog pages, namely: + + + + Documentation Collections + Full Text Search + Other + + + +Setting Up Documentation Collections + + +The documentation configuration settings have been divided into a series of documentation collections, each providing access to documentation files of some unique format and content type. These setups control which documentation items will be listed on the Contents page of the &kdevelop; Documentation facility, and how the user may access documentation details by indexed and full text searches. + + +The Documentation tab provides a series of configuration pages which are ordered vertically like a stack of index cards. One page at a time will open after a click on its index card title: + + + &Qt; Documentation Collection + CHM Documentation Collection + Doxygen Documentation Collection + &kdevelop; TOC Documentation Collection + Devhelp Documentation Collection + Custom Documentation Collection + + + + + + + + +Setting up documentation collections + + Setting up documentation collections + + + + + + +Common Documentation Setup Structure + + +All configurations pages on the Documentation tab use a common layout. You will find the currently available documentation items of this type listed on the open page to the left and a set of buttons to the right. + + + + +Buttons to Maintain Documentation List Contents + + +There are three buttons available to maintain the contents of the documentation setup pages: + + + + + Add + + Opens a Documentation Catalog Properties dialog as shown below where you can select the source location of the documentation item to be added and name it. + + + + Edit + + Opens a Documentation Catalog Properties dialog as shown below where you can change the source location of the documentation item previously selected in the list and rename it. + + + + Remove + + Removes the selected documentation entry from the list. + + The entry will be removed from the list only. Actual documentation sources remain untouched. You will have to remove them explicitely by other means. + + + + + + + + + + + + Add or change a documentation item + + + + + +The button to the right of the Location field opens a directory dialog whose entries usually will be filtered according to the file type of the selected configuration page. + + +The Title field may not be accessible, depending on the documentation type to be maintained. + + + + +Documentation List Structure + + +Every documentation setup page shows the listed documentation items in a table with four columns: + + + + + TOC + + + If this check box is marked, this documentation item will show up on the Contents page of the &kdevelop; Documentation facility. + + + Unchecking the TOC check box will in turn disable the Index and Search check boxes (see below). Thus you cannot have documentation collection items indexed but not shown in the contents. + + + + + Index + + + If this check box is marked, an internal index will be built of this documentation item. This provides fast access to the documentation by the use of the Index and (optionally) Finder pages of the &kdevelop; Documentation facility. + + + + The internal index will be built the first time the user selects the Index page. This will delay the first access noticeably, because the index will be read from disk and then cached. + + + All subsequent indexed searches will however use this chache and thus work significally faster. + + + + + + Search + + + If this check box is marked, the contents of this documentation item will be included in the full text search path of the Search page of the &kdevelop; Documentation facility. + + + + &kdevelop; utilizes the htdig application collection to perform full text searches. This search is done over an internal index, the htdig machinery has to build before it can be used. + + + Any change of the Search check box marks will thus effect the search runs only after you rebuilt the index on the Search page of the &kdevelop; Documentation facility. + + + + + + Title + + This is the name of the Documentation item as it will be shown on the Contents page of the &kdevelop; Documentation facility. + + + + + +Former &kdevelop; versions allowed to select the documentation items to be displayed on a per-project basis. This is not available any more. + + + + + + + + +&Qt; Documentation Collections + + +On this configuration page all &Qt; documentation is set up. + + + + + + + +Setting up the &Qt; documentation collection + + Setting up the &Qt; documentation collection + + + + + +Normally &kdevelop; will fill this in on its first start-up. It looks for standard *.xml, or *.dcf documentation files in the &Qt; installation directory. The table to the left lists the files &kdevelop; found by their standard titles. + + + +If you have a non-standard installation, either there will be no information listed at all or the entries will possibly refer to improper locations (⪚ to another &Qt; installation available in your system). You may adjust the entries using the buttons to the right of the list field. + + + +&kdevelop; will use the titles already provided by the installed &Qt; documentation. Hence the Title field in the Documentation Catalog Properties dialog is inaccessible. + + + +By default, not all &Qt; documentation will be shown on the Contents page of the &kdevelop; Documentation facility. Use the TOC check box in the setup table to select the documentation to be shown. + + + +If you want to have some specific &Qt; documentation included in the search indexes or full text search use the Index and Searchcheck boxes in the setup table. + + + + + +Setting Up the CHM Documentation Collection + + +On this configuration page you may collect documentation according to the &Microsoft; CHM help file standard. + + + + + + + +Setting up &Microsoft; CHM standard documentation files + + Setting up &Microsoft; CHM standard documentation files + + + + + +By default, this configuration page will be empty (as shown above). You may add new entries using the buttons to the right of the list field. &kdevelop; will filter *.chm files in the directory dialog associated to the Add and Edit buttons. + + + +For more information on the format of &Microsoft; *.chm files see ⪚ PHP: Documentation - Extended CHM Format at http://de2.php.net/docs-echm.php. + + + + + +Documentation Generated by Doxygen + + +On this configuration page all &API; documentation generated by &doxygen; is set up. + + + + + + + +Setting up Doxygen generated &API; documentation + + Setting up Doxygen generated &API; documentation + + + + + +In short, such an &API; documents the interface to certain library functions. The &API; documentation on this page should be produced by the externally provided &doxygen; tool. + + +&doxygen; generated &API; documentationconsists of a series of html files, starting with index.html. Additionally there may exist tag files which contain information to link to already existing &API; documentations. Thus &kdevelop; will look for index.html and *.tag files when seaching for &doxygen; generated &API; documentation. + + +There are some structural constraints assumed when searching for &doxygen; generated &API; documentation. The directory in which the index.html file resides should contain subdirectories with separate documentation collections. Each of these subdirectories is assumed to contain a .tag file and a html/ subdirectory. + + +You may have a look at $KDEDIR/share/doc/HTML/en/kdelibs-apidocs for an example of such a &doxygen; &API; documentation layout. + + + +The older &kde; KDoc generated &API; format is not directly supported any more. If you still want to use such documentation, you may add it on the Custom Documentation Collection page. + + + +&kdevelop; will have filled in a link to the current &kde; Libraries &API;, provided it found one. There are several ways for &kdevelop; to find out: + + + + + Either you provided the configure command with the + option when you compiled + &kdevelop; (see the How to Obtain a &kdevelop; &API; Documentation chapter). + + + Or the configure command did automatically find a &doxygen; generated &kde; Libraries &API; in one of several standard locations it knows of. + + + Or as a last resort the $KDEDIR/share/doc/HTML/en/kdelibs-apidocs/ was found at the first &kdevelop; startup. + + + + +If &kdevelop; did not find a valid &doxygen; generated &kde; Libraries &API; at its first start-up the Doxygen Documentation Collection list will be empty. + + + +You may add your own &API; documentation entries (⪚ from your current projects) by using the buttons to the right. If you want to have them included in the indexed and/or full text search mark the Index or Search check boxes in the setup table. + + + +&kdevelop; uses the title information from the index.html. Hence the Title field in the Documentation Catalog Properties dialog is inaccessible. + + + + + The &kde; system provides more &API; documentation than the &kde; Libraries &API; only. You will need additional interfaces information if you want to ⪚ include the &kate; part into you programs. For this &kate; part &API; for example you should compile and install the &kde; Base Libraries &API; from the sources (using the make apidox and make install commands on the kdebase sources) and then add an entry to the Doxygen Documentation Collection list like this: + + + + + +Adding a &kde; base &API; to the list + + Adding a &kde; Base &API; to the list + + + + (Of course you should replace the /home/dev/mykde-system/ directory in the Location field example with the path to your &kde; installation.) + + + + +You must put the &API; of your current project into this Doxygen Documentation Collection as well. Former &kdevelop; versions did put it into the documentation tree on a per-project basis. This is not provided any more. + + + + + +Handling Structured Documentation (KDevelopTOC Files) + + +The main bulk of the &kdevelop; documentation facility provides immediate access to structured documentation, local as well as remote ones. You can configure this on the KDevelopTOC Documentation Collection page. + + + + + + + + + Providing KDevelopTOC structured documentation access + + + + + +&kdevelop; comes with a bunch of predefined KDevelopTOC files which are automatically entered in the table at installation time. To keep the display manageable only the most often used will initially be marked for display. If you want to see another documentation, mark the TOC check box in the setup table. + + + +KDevelopTOC files cannot be indexed to perform a full text search because they usually point to a remote location. On the other hand, such a .toc file can have an index manually defined, using the <index> tag. Thus the Index check box will be enabled ony when &kdevelop; finds an <index> tag in the .toc file. (For more detail see the description below in the &kdevelop; TOC Files section.) + + +The Search check box in the setup table will alway be disabled. + + + +You may add new entries using the buttons to the right of the list field. &kdevelop; will filter *.toc files in the directory dialog associated to the Add and Edit buttons. + + + +Other than former &kdevelop; versions will the Remove button not change the *.toc files on disk, so the remove operation is safe now. + + + + + +&kdevelop; TOC Files + + +There is a special feature associated with this. To illustrate, follow these steps: In the documentation tree find an entry shortly below the &Qt;/&kde; documentation (⪚ KDE2 Development Book (kde.org)). Click on the plus sign next to it. A tree will open where you can quickly navigate to subsequent chapters nested several levels deep, all offline. But if you finally select one of the chapters, &kdevelop; will in many cases try to access a remote documentation file. + + + +The rationale behind this is not only to locally navigate remote documentation without wasting net access ressources, but to provide the developer with easy, structured access to the documentation he/she needs. Using these tools one can access almost any local or remote documentation in a structured fashion even if the original is laid out flat or structured in another way. All that is needed is access to files and/or parts of files which are displayable by the Konqueror. + + + +Such structured access is made possible through the use of special table of content files, which are denoted by .toc filename extensions. Any such &kdevelop; TOC file contains an &XML; structured description of the document to be accessed. + + + + +Standard Directory of &kdevelop; TOC Files + + +When &kdevelop; was installed usually a series of predefined .toc files has been put into the $KDEDIR/share/apps/kdevdocumentation/tocs directory. These are fairly simple, structured text files. You may look at them using a text editor or other text display facility. + + + + + + + + + + Basic Structure of &kdevelop; TOC Files + + header + + + + <!DOCTYPE kdeveloptoc> + + + <kdeveloptoc> + + + (title) + + + (base address) + + + (content structure) + + + (index structure) + + + </kdeveloptoc> + + + + This &XML; structure will be parsed by the &kdevelop; Documentation plugin to set up the documentation tree contents and to guide the user in navigating the documentation. It contains all information necessary to display titles and access the documentation file contents. + + + + + title + + + + <title> + (some title string) + </title> + + + + This is the title &kdevelop; will display at the basic levels in the documentation tree. + + + This displayed title cannot be changed by the user. If you want another text be displayed, you must manually change the <title> entry in the .toc file. + + + + + base address + + + + <base href=" + (base document &URL;) + "/> + + + + This &URL; points to the location where all files of this documentation are located. It will be prepended before each section &URL; in the following content structure list. So, if you ⪚ downloaded a documentation from a remote server, all you need to display the files from this new location is to change its <base> &URL;. + + + + + content structure + + + + <tocsect1 name=" + (section title) + " url=" + (section &URL;) + "> + + ... + + <tocsectn name=" + (section title) + " url=" + (section &URL;) + "/> + + ... + + </tocsect1> + + + + All remaining navigation and access information is stored in a series of nested <tocsecti> ... </tocsecti> pairs. Each i denotes a consecutive nesting level down to number n which will correspond to the finally displayed documentation section. + + + Any <tocsecti> entry must have a name="xxx" attribute associated with it (the "xxx" denotes the actual title string). This name will be displayed as level title in the documentation tree. It should correspond to an actual documentation section. + + + There may be an url="" attribute associated with any i nesting level. When the user clicks on a section title in the documentation tree &kdevelop; will try to access the file at the location pointed to by the combined base and section &URL;. + + + The <tocsectn/> entry must have an url="" attribute whatsoever. + This final nested <tocsectn/> does not come in pairs but will immediately be closed by a / before the > bracket. + + + Any address combined of base and section &URL; must point to some displayable text file. Usually this will be an HTML-structured file. It is possible to link to anchor marks within such an HTML file using the standard # notation of the format: /base-url/section-url#anchor-mark. + + + + + index structure + + + + <index> + + + <entry name=" + (index entry title) + " url=" + (index section &URL;) + "/> + + + </index> + + + + Index is a plain list of index entries - pairs of title and &URL;. Index is not mandatory. + + + + + + + + + +DevHelp Documentation + + +DevHelp documentation is another means of structured documentation access. It uses structured table of content files denoted by a .devhelp extension similar to &kdevelop; TOC files to access documentation for the GNOME 2 desktop. + + +You can control which DevHelp files should be accessible on the DevHelp Documentation Collection configuration page. + + + + + + + + + Providing DevHelp documentation + + + + + +DevHelp files originally were accessible on the LiDN website, but this seems to be not maintained for some time now. More recent DevHelp documentation is available at the DevHelp Books Download web page. + + + +When &kdevelop; is installed it will attempt to find all .devhelp files in some standard places in the system, ⪚ in the subdirectories of /opt/gnome/share/. Initially these files will not be marked for display. If you want to see another documentation, mark the TOC check box in the setup table. + + + +You may add new entries using the buttons to the right of the list field. &kdevelop; will filter *.toc files in the directory dialog associated to the Add and Edit buttons. + + + + + +Setting Up Custom Documentation Collections + + +This is for your own purpose. You may add almost any documentation files here, provided they can be displayed by the &konqueror; plugins. + + + + + + + + + Providing custom documentation + + + + + +Usually this collection will be empty at first &kdevelop; startup. We have filled in a deliberate item to show the entry structure. + + +Handling is straightforward here. Use the buttons to the right of the list field to add, edit or remove the document items. &kdevelop; will not filter anything in the directory dialog associated to the Add and Edit buttons. + + + +You will have to explicitely select the items for display in the &kdevelop; documentation facility. Mark the TOC check box of the entry in the setup table. + + + +Custom documention cannot be indexed or searched. Thus the Index and Search check boxes have no effect here as shown above. + + + + + + + +Setting Up Text Search Indexes + + +(... to be written ...) + + + + + + + + + Setting up text search indexes + + + + + + + +Other Documentation Configuration Settings + + +(... to be written ...) + + + + + + + + + +Advanced Configuration + + +(... to be written ...) + + + +Plugin Tools + + +(... to be written ...) + + + + + + diff --git a/doc/kdevelop/split-source-header-navigate.png b/doc/kdevelop/split-source-header-navigate.png new file mode 100644 index 00000000..f4d72868 Binary files /dev/null and b/doc/kdevelop/split-source-header-navigate.png differ diff --git a/doc/kdevelop/split-source-header.png b/doc/kdevelop/split-source-header.png new file mode 100644 index 00000000..d57b306b Binary files /dev/null and b/doc/kdevelop/split-source-header.png differ diff --git a/doc/kdevelop/split-windows.png b/doc/kdevelop/split-windows.png new file mode 100644 index 00000000..3ebb79f5 Binary files /dev/null and b/doc/kdevelop/split-windows.png differ diff --git a/doc/kdevelop/split-workspace.png b/doc/kdevelop/split-workspace.png new file mode 100644 index 00000000..d497ab49 Binary files /dev/null and b/doc/kdevelop/split-workspace.png differ diff --git a/doc/kdevelop/survey-manual.docbook b/doc/kdevelop/survey-manual.docbook new file mode 100644 index 00000000..d9611a03 --- /dev/null +++ b/doc/kdevelop/survey-manual.docbook @@ -0,0 +1,228 @@ + +What This Manual Contains + + +This user manual is intended to describe the contents and use of the &kdevelop; &kdevrelease; Integrated Development Environment (IDE) from a user's point of view. It is not a programming manual, nor does it describe the development process in detail. Its only aim is to guide you in the handling of the IDE. + + +Here you will find information on the following topics: + + + +Getting Started with &kdevelop; — a Guided Tour + +Gives you a quick start on the use of this &IDE;, introducing the basic steps of how to work on a project. + + + +Overview of the Features of + &kdevelop; + +Extends the guided tour in the previous chapter, giving an overall +view of what is built-in within &kdevelop; and gets you acquainted with the +look and feel of this &IDE;. + + + + +Configuring &kdevelop; + +Shows how you can tailor the &IDE; to suit your needs. + + + + +Getting started: the +&appwizard; + +Describes the basics of how to set up a new project in &kdevelop; +using the built-in &appwizard;. + + + + +Editing tools + +All you need to write your source files: using the editor, searching +for text both locally and project-wide, up to integrating new files and +classes into the project. + + + + +The File Browsers + +Demonstrates various tools to look at the structure of your project +and how to access the files you want to work with. + + + + +The Class Browsers + +Describes one of the most powerful tools of &kdevelop; which lets you +navigate through class dependencies and allows you to easily create and +access the classes and methods you need. + + + + + +Documentation + +Shows how to access the rich built-in documentation &kdevelop; +provides and tells you how to create documentation of your project, concise +and powerful &API; documentation providing you an overall view of all your +project sources as well as docbook-based user documentation. + + + + +Building and Project + Management + +Deals with the creation and management of your project; describing the +basics of autoconf and automake as well as how to set up custom make files +and how to use compiler or make options to tailor your application to suit +your needs. + + + + +Advanced Build + Management + +Looks at ways to keep multiple build configurations, to cross-compile +for diverse platforms, or to make an embedded system using the +Qt/embedded library. + + + + +The Debugger Interface + +Describes how to use the integrated gdb +debugger interface so you can hunt down bugs without leaving +&kdevelop;. + + + + + + +Using CVS + +Tells you how you can maintain your project using the CVS versioning +system; a must, especially if many developers work on the same +project. + + + + + + +Some commonly used information has been put into the appendix. Amongst others this consists of: + + + + +Installing &kdevelop; + +Tells you where to obtain &kdevelop; and how to get it up and +running. + + + + + + +In a Nutshell — Tips and +Tricks + +A quick reference to commonly used commands and actions. And a short +guide to solve common problems when working with +&kdevelop;. + + + + +Development on &UNIX; + +A historical overview of &UNIX; program development, the main tools +necessary and why you need an &IDE;. + + + + + + +Configuration Files Used by + &kdevelop; +Lists the files &kdevelop; uses to save its internal + information. This is particularly useful in case something went wrong with + your setup. + + + + +Plugin Tools +Lists the pluggable tools you can use to taylor the capabilities of +&kdevelop; to your needs. + + + + +KDevelop User Interface Mode Examples +Shows user interface modes. + + + +Further Information +Getting Information, reporting Bugs etc. + + + +Changelog +Shows the history of this documentation. + + + +Bibliography +Bibliography + + + + + + + diff --git a/doc/kdevelop/tutorial-debug-tree.png b/doc/kdevelop/tutorial-debug-tree.png new file mode 100644 index 00000000..23c7f2c6 Binary files /dev/null and b/doc/kdevelop/tutorial-debug-tree.png differ diff --git a/doc/kdevelop/tutorial-hello-new.png b/doc/kdevelop/tutorial-hello-new.png new file mode 100644 index 00000000..abbb912d Binary files /dev/null and b/doc/kdevelop/tutorial-hello-new.png differ diff --git a/doc/kdevelop/tutorial-hello-options.png b/doc/kdevelop/tutorial-hello-options.png new file mode 100644 index 00000000..7b9d98cd Binary files /dev/null and b/doc/kdevelop/tutorial-hello-options.png differ diff --git a/doc/kdevelop/tutorial-new-project.png b/doc/kdevelop/tutorial-new-project.png new file mode 100644 index 00000000..8f3aa78d Binary files /dev/null and b/doc/kdevelop/tutorial-new-project.png differ diff --git a/doc/kdevelop/unixdev.docbook b/doc/kdevelop/unixdev.docbook new file mode 100644 index 00000000..d7881afb --- /dev/null +++ b/doc/kdevelop/unixdev.docbook @@ -0,0 +1,386 @@ + + + + + BerndPol + + + + +Development on &UNIX; + +development + + &UNIX; + development + + +Some Historical Remarks + +history +scripting languages + + &UNIX; + history + + &UNIX; + pipe + + &UNIX; + shell + + shell + &UNIX; + + +From the beginning, &UNIX; has maintained two very different development paradigms. One is the world of system and application programming languages, where some source code is translated to machine code by a translation program, usually a compiler or an interpreter. The programming language C is an example. &UNIX; was the first operating system kernel to be written in such a high level language instead of tightly machine-oriented assembler which was common before that time. (In fact, the C language once even was invented to write the &UNIX; kernel and associated programs on a DEC PDP-11 computer.) + + +The other paradigm is the world of scripting languages. This world evolved with the invention of the &UNIX; shell which was the user's interface to the operating system—and at the same time a very high level programming language. A shell script is built from a set of small utility programs like ⪚ grep, sed, or find. Each such utility is designed for some tightly defined job. The trick is that any such utility can be connected to another one via a simple transport mechanism, called a pipe, which directs the output of the foregoing utility into the input of the next processed one. This makes for a very powerful and highly flexible programming tool. + + +As time has gone by, both worlds have evolved. While C is still used mainly as a system programming language, C++ as a variant of C enriched by object-oriented and generic extensions has found its place for the development of complex applications in the 1990's. There are numerous other programming languages, even older ones keep their place—FORTRAN77 and Ada ⪚ still have their stronghold in numerical applications. + + + + + + +Contemporary Scripting Languages + +In the scripting area, there has been a shift away from the shell, which suffers from portability concerns, to languages which unify all commonly needed functionality in their standard libraries, while still being able to interface to the outside through pipes when necessary. + + +All these scripting languages have in common that they are widely portable between &UNIX; variants, Microsoft &Windows;, &MacOS; or even VMS. Also, they all have implementations that are freely distributable. + + + +&perl; + +Perl + + scripting languages + Perl + + +&perl; has become popular as a text processing and system administration language. In the beginning of the World Wide Web, CGI scripts written in &perl; were a widely used method to create dynamic web pages from databases. Today, this method has been replaced mostly by the mod_perl plugin for the &apache; web server. Among &perl;'s strengths are its built-in support for advanced regular expression matching and its rich archive of freely distributed modules. + + +For more information see the Comprehensive Perl Archive Network (CPAN) website. + + + + +Python + +Python + + scripting languages + Python + + +&python; shines by the elegance of its class system and the ease and flexibility with which external libraries can be wrapped in a way that they appear like standard &python; classes and functions. In contrast to &perl;, &python; has a clear and concise embedding &API;, which makes it the language of choice for making C and C++ programs scriptable. + + + + +PHP + +PHP + + scripting languages + PHP + + +&php; was invented as a language directly embeddable into &HTML; pages and consequently has its main uses in delivering dynamic content on the web. + + + + + + +Higher-level Scripting + + +Higher-level &UNIX; applications usually miss the speed and flexibility of the traditional character-oriented shell scripting mechanisms. This is especially true in the world of graphical user interfaces (&GUI;) such as ⪚ &kde;. + + +There have been attempts to provide similar mechanisms which will work on a higher application level, most notably CORBA and, in the &kde; environment, &DCOP;. + + + +The CORBA Protocol + +CORBA + + scripting languages + CORBA + + communication + CORBA + + +CORBA (Common Object Request Broker Architecture) is an attempt to let computer applications work together over networks. It was devised by the private, vendor independent OMG (Object Management Group) standards comittee. + + +CORBA-based programs use the IIOP standard protocol to communicate. Implementations based on IIOP are available on a wide variety of operating systems, programming languages, and networks and are thus highly portable. + + +The main drawback of CORBA is its rather low speed. While this may be tolerable in networks, it is a real hindrance for inter-application communications in a non-networked environment such as &kde; running on a single computer. + + + + + +The &DCOP; Interface + +DCOP + + scripting languages + DCOP + + communication + DCOP + + +Another evolution on &UNIX;-like scripting is the DCOP protocol which was devised for communication between &kde; applications to overcome the limitations of CORBA. + + +&DCOP; stands for Desktop Communication Protocol and is implemented as a simple IPC/RPC mechanism built to operate over sockets. In effect this provides facilities similar to the traditional &UNIX; pipe mechanism. + + +Traditional shell scripting is based on fairly small tool programs which were designed to work on a strictly textual basis. &DCOP; allows elaborate graphical programs to communicate with each other in a quite similar way. This enables ⪚ a &kde; program to send messages to another &kde; program, or receive data from it for its own purposes. + + +There are drawbacks, however. To use &DCOP; a program must be designed to contain a special &DCOP; interface. And the &DCOP; communication process runs somewhat slowly (although a lot faster than CORBA). But it returns much of the power and flexibility of &UNIX; scripting to high-level programs which are based on a graphical user interface. + + +For more information, see the DCOP: Desktop COmmunications Protocol paper or The &DCOP; Desktop Communication Protocol library &API; reference of the &kde; dcop library. + + + + + + + + +Build Systems + + +Except in very simple cases a programming project will consist of a lot of building blocks of source code each put into a separate file for easier maintenance. To make this running one has to effectively translate all this stuff into a few machine language units in a suiting format which allows the operating system to load and execute the program. + + +To accomplish this, the basic tools needed are + + + a text editor to write the source code files, + + + a translating program, usually a compiler to turn the source code into object files, + + + a librarian which collects object files into libraries to reuse them easily without the need to recompile, + + + a linker which binds several object files and libraries together into one executable, + + + a make system which provides some means to manage all this stuff and—not to forget + + + a debugger to (hopefully) find all errors in the program and possibly some other diagnostic tools to get everything running smoothly. + + + + + +When you have a large project consisting of possibly hundreds of source code files, the process of compiling may become quite laborsome. You do not want to recompile all files each time you have changed only some of them. Instead, you only want to compile those files which are affected by the changes. In general, it is not always easily obvious which of the files have to be recompiled. + + +When you ⪚ change a function prototype in a header file, you need to compile every file which includes this header file. If your project contains many such files you may easily miss one or two of them if you have to do the job manually. Thus some means of automization is necessary. + + + +The Make Process + + + make + + Makefile + + rule + + recompilations + + target + + dependencies + + commands + + +A tool which takes care of recompilations is make. It keeps track of all work using a set of rules which describe what to do in case some piece of information (usually a source or object code file) was changed. All rules belonging to a certain project are stored in a so-called Makefile which is processed by make any time you want to update your work. + + +Each rule consists of several building blocks, namely + + + a target, &ie; the file to be built + + + a set of dependencies, basically the names of those files the target depends on (⪚ the name of a source file, where then the target will be the name of the object file to be built) and + + + the commands which are to be executed to make the target (&ie; to compile it or to link other object files together to build an executable progam file). + + + + +Basically the make command will read the rules one after another, check each file in the dependency list of a given target and make this target anew if any one of these files has changed, using the commands listed in that rule. + + +There are several additional possibilities to control such a make process, and a Makefile can thus grow very complex. We cannot go into the details here. However, we recommend that you make yourself accustomed to the syntax of make. Even if you do not normally use it directly, an understanding of the fundamentals of the build system can be useful. See the GNU Make Manual for more information. + +For more &kdevelop; specific detail see the Building and Project Management chapter of this manual. + + +There are several tutorials available, see the references in the Building and project management chapter. + + + + + + + + +&GUI; Development + + + GUI + + graphical user interface + + user interface + GUI + + +Application developers become even more encumbered by having not only to create program libraries and logic, but also to provide an easy to use custom built user interface that is both intuitive and functional. Most programmers receive little to no training in &GUI; development, and as a result user interfaces often are poorly designed. + + +During the years some common design principles have evolved. It is strongly advised to adhere to them. This way your user interfaces will retain a common look and feel that the users of your application will gratefully appreciate. + + +For &kde; &GUI; development there is a style guide available. It is found in the &kde; User Interface Guidelines on the &kde; Developer's Corner page. + + +A short introduction to common &GUI; design principles can be found here. + + + + + + + +Integrating Concepts and Tools – the IDE + + + IDE + + integrated development environment + + development + IDE + + environment + IDE + + +There are separate tools available for almost any step in the programming process—planning, editing, managing files and compilation processes, debugging, documentation and the like. But once the projects grow the programming processes will most likely become quite cumbersome. + + +Much repetitive work has to be done when designing, compiling, and debugging a program. A lot of such work can be saved through the use of templates and scripts. And another lot by keeping these tools easily available and able to communicate with each other under a common &GUI;. + + +For example—would it not be convenient if a debugger were able to open the source file in question in an editor and place the cursor directly at the position of that bug just found? + + +To more easily accomplish such a scheme, Integrated Development Environments (&IDE;s) were devised. Such an &IDE; integrates all templates, tools, and scripts which are commonly needed in the development process into one single environment. + + +For the &kde; platform &kdevelop; is such an &IDE;. It provides a wide range of tools which ease program development and maintenance, even for different programming languages and across platforms. + + + +Basic Features of &kdevelop; &kdevrelease; + + + &kdevelop; + features + + features + + + + + + Manages all development tools needed for C++ programming, such as compiler, linker, debugger and build system. + + + Provides an &appwizard; which generates complete, ready-to-go sample applications. + + + Allows the user to select an integrated editor based on the &kde; programmer's editor &kwrite;, Trolltec's QEditor, or others. + + + A class generator, for creating new classes and integrating them into the current project. + + + File management for sources, headers, documentation &etc; to be included in the project. + + + Assistance in creating application user manuals written with &kde; tools. + + + Automatic &HTML; based &API; documentation for a project's classes with cross-references to the used libraries. + + + Internationalization support, allowing translators to add their target language to a project easily, including support for &kbabel;. + + + Support for managing a project via one of several versioning systems (⪚ &CVS;) by providing an easy-to-use frontend for the most needed functions. + + + An integrated debugger frontend. + + + An integrated shell console emulator. + + + Syntax highlighting in source texts. + + + An auto-code completion facility for class variables, class methods, function arguments and more. + + + Templates for creating various projects (&kcontrol; modules, &kicker; (panel) applets, KIOSlaves, &konqueror; plugins and desktop styles). + + + Four navigation tree views for easily switching between source files, header files, classes and documentation, obviating the need for an external file manager. + + + Cross-compiling support, with the ability to specify different compilers, compiler flags, target architecture, &etc; + + + Support for Qt/Embedded projects (such as the Zaurus and iPAQ). + + + Inclusion of any other program you need for development by adding it to the Tools menu according to your individual needs. + + + + + + + + + diff --git a/doc/kdevelop/wrong-project-location.png b/doc/kdevelop/wrong-project-location.png new file mode 100644 index 00000000..cb9c45a2 Binary files /dev/null and b/doc/kdevelop/wrong-project-location.png differ diff --git a/doc/platform/Mainpage.dox b/doc/platform/Mainpage.dox new file mode 100644 index 00000000..dd69ba92 --- /dev/null +++ b/doc/platform/Mainpage.dox @@ -0,0 +1,148 @@ +/** \file Mainpage.dox + \brief The main page of the doxygen generated %API Documentation +*/ + +/** +\mainpage The KDevelop Platform %API %Documentation + + +KDevelop Platform is set of libraries and tools that are used to build IDEs (Integrated Development Environments), +applications similar to IDEs (web development enviroment, text editors for programmers and designers, etc.) +and/or IDE plugins for all possible purposes. + +Platform provides: +- the plugin architecture (interfaces); +- the common support libraries; +- the generic shell with plugin profiles support. +. + +\section intro Introduction + +This document is targeted at all those that want to build their own IDE or improve KDevelop's source code. +If you are instead looking for a user manual, just go to the help menu of your KDevelop and select KDevelop handbook. +This documentation contains the KDevelop Platform online class reference for the current +development version of KDevelop. Additionally, you +can subscribe or read the mailing list for any additions and/or +modifications to the Platform %API. + +An on-line, updated every 24H, html version of this documentation can be found at: http://www.kdevelop.org/HEAD/doc/platform/html/index.html + +You can also download a local browseable copy form http://www.kdevelop.org/HEAD/doc/platform/kdevplatformdoc.tar.bz2 . It gets updated every single day too. + +More information about the KDevelop Platform architecture in form of tutorials, Wikis, HOWTOs, +and FAQs can be found at +the KDevelop website. + +Quick overviews of the architecture can also be found in the issues of +KDevelop Technotes. + +\section platformapi Platform Libraries API + +- Interfaces Library + (classes)\n + Interfaces and classes that form KDevelop plugin architecture. +- Extension Interfaces Library + (classes)\n + Extension interfaces used by KDevelop plugin architecture. +- Utility Library + (classes)\n + Utility classes for the KDevelop architecture. +- Extra Interfaces Library + (classes)\n + Extra interfaces that are not the part of KDevelop plugin architecture + but that can be implemented by extra plugins or "plugins for plugins". +- Widgets Library + (classes)\n + A collection of widgets. +- Property Editing Library + (classes)\n + A collection of facilities to store and edit the properties of various objects. +- Catalog Library + (classes)\n + The persistant symbol store library working with BerkeleyDb backend. +. + +\section designerapi GUI Designer Integration API + +- KInterfaceDesigner Library + (classes)\n + KInterfaceDesigner classes and interfaces which form the core of GUI Designer integration framework. +- Designer Integration Support Library + (classes)\n + The base classes to implement GUI designer integration in language support plugins. +. + +\section pluginsapi Platform Plugins API + +- Documentation Part Interfaces Library + (classes)\n + Interfaces to implement KDevelop documentation plugins. +. + +\section langapi Programming Language Support API + +- Language Support Interfaces Library + (classes)\n + Interfaces for KDevelop language support facilities. +- Debugger Support Library + (classes)\n + Classes to implement debugger support for a programming language. +. + +\section buildtoolapi Buildtool Support API + +- Buildtool Base Library + (classes)\n + Base classes for KDevelop builtool support plugins. +- Project Manager Interfaces Library + (classes)\n + Interfaces to implement plugins for the KDevelop generic project manager. +- Buildtool Widgets Library + (classes)\n + Widgets commonly used in buildtool support plugins. +- Autotools parser Library + (classes)\n + Parser for Autotools based support plugins. +- QMake parser Library + (classes)\n + Parser for QMake based support plugins. +. + +\section shellapi Shell API + +- Generic Shell + (classes)\n + The Shell - a profile-based implementation of KDevelop plugin architecture. +- Shell Profiles Library + (classes)\n + Plugin profiles implementation for KDevelop shell. +. + +\section PlannedTasks Planned tasks + +Here is a priority ordered list: + -# fix the dispersed fixme + -# reported bugs in bugzilla database + -# fix the dispersed todo all over the code. + . + +\section howTobuildAPIlocalcopy How to build a local copy of this documentation + +This documentation is large and changes with every cvs commit, therefore is not available for download. +To build your local copy of this documentation you need to fetch KDevelop sources and +if you have doxygen >= 1.3.4 and (optionally) PHP >= 4.10 plus a local running webserver then +- make apidox +- make install-apidox (as root) +. + +The advantage of the webserver is that you'll get a search engine in your documentation if you read your +documentation using your local webserver. + +\section License + +Permission is granted to copy, distribute and/or modify this document under +the terms of the GNU Free %Documentation License, Version 1.2 or any later +version published by the Free Software Foundation; For details see +http://www.gnu.org/copyleft/fdl.html . + +*/ diff --git a/doc/std/Makefile.am b/doc/std/Makefile.am new file mode 100644 index 00000000..07f12cde --- /dev/null +++ b/doc/std/Makefile.am @@ -0,0 +1,7 @@ +tocdir = ${kde_datadir}/kdevdocumentation/tocs +toc_DATA = kdev3api.toc + +#indexdir = ${kde_datadir}/devdoctreeview/indices +#index_DATA = + + diff --git a/doc/std/kdev3api.toc b/doc/std/kdev3api.toc new file mode 100644 index 00000000..28d9cf3a --- /dev/null +++ b/doc/std/kdev3api.toc @@ -0,0 +1,45 @@ + + +KDevelop API Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/tools/Makefile.am b/doc/tools/Makefile.am new file mode 100644 index 00000000..4eb7f5af --- /dev/null +++ b/doc/tools/Makefile.am @@ -0,0 +1,4 @@ +EXTRA_DIST = index-texi index-python index.xsl \ + toc-gsdoc toc-docbook toc-python + + diff --git a/doc/tools/index-python b/doc/tools/index-python new file mode 100644 index 00000000..96cfcd8f --- /dev/null +++ b/doc/tools/index-python @@ -0,0 +1,52 @@ +#!/usr/bin/perl + +use Getopt::Long; + +my $prefix = ''; +GetOptions( 'prefix=s' => \$prefix ) || die "Wrong options\n"; + +$file = $ARGV[0]; +open(FILE, "$file") || die "File not found: $file\n"; + +print "\n"; + +$ingroup = 0; +while () { + + if (/\\(.+)\<\/a\>/) { +# print "Index: $1, $2, $ingroup\n"; + if ($ingroup) { + $name = "$ingroup, $2"; + } else { + $name = $2; + } + $url = "$prefix/$1"; + print "\n"; + } elsif (/\(.+)/) { +# print "Ingroup: $1\n"; + $ingroup = $1; + } elsif (/\s+\<\/dl>/) { + $ingroup = 0; + } +} + +print "\n"; +close(FILE); + + +sub dehtml +{ + my ( $str ) = @_; + + $str =~ s/\//g; + $str =~ s/\<\/CODE\>//g; + $str =~ s/\//g; + $str =~ s/\<\/TT\>//g; + + return $str; +} + +# Local Variables: +# mode: perl +# fill-column: 120 +# End: diff --git a/doc/tools/index-texi b/doc/tools/index-texi new file mode 100755 index 00000000..8aa85184 --- /dev/null +++ b/doc/tools/index-texi @@ -0,0 +1,60 @@ +#!/usr/bin/perl + +use Getopt::Long; + +GetOptions( 'map=s' => \%mapping ) || die "Wrong options\n"; + +for $file (@ARGV) { + + open(FILE, "$file") || die "File not found: $file\n"; + + $indir = 0; + + while () { + + if (/\\(.*)\<\/A\>\<\/H1\>/) { + $index = $mapping{$1}; +# print "Index: $1 => $index\n"; + } elsif (/\/) { + $indir = 1; + } elsif (/\<\/DIR>/) { + $indir = 0; + } elsif ($indir) { + if (/\\([^<]*)\<\/A\>/) { + unless ($lastindex eq $index) { + if ($lastindex) { + print "\n"; + } + print "<$index>\n"; + $lastindex = $index; + } + $name = dehtml($2); + $url = $1; + print STDOUT "\n"; + } + } + } + + close(FILE); +} + +if ($lastindex) { + print "\n"; +} + +sub dehtml +{ + my ( $str ) = @_; + + $str =~ s/\//g; + $str =~ s/\<\/CODE\>//g; + $str =~ s/\//g; + $str =~ s/\<\/TT\>//g; + + return $str; +} + +# Local Variables: +# mode: perl +# fill-column: 120 +# End: diff --git a/doc/tools/index.xsl b/doc/tools/index.xsl new file mode 100644 index 00000000..8d3d0a52 --- /dev/null +++ b/doc/tools/index.xsl @@ -0,0 +1,34 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/tools/toc-docbook b/doc/tools/toc-docbook new file mode 100644 index 00000000..6d16f9b3 --- /dev/null +++ b/doc/tools/toc-docbook @@ -0,0 +1,71 @@ +#!/usr/bin/perl + +# Copyright (C) 2001 by Claudiu Costin +# +# +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 2 of the License, or +# (at your option) any later version. + +use Getopt::Long; + +my $prefix = ''; +my $depth = 1; +GetOptions( 'prefix=s' => \$prefix, + 'depth=i' => \$depth ) || die "Wrong options\n"; + +$initialdepth = $depth; +$b3=$b2=$b1=""; +$in_processing=0; +while (<>) { + chop; + + if (/Table of Contents<\/B/) { + $in_processing=1; + next; + } + last if (/List of Tables/); + next if (!$in_processing); + + if (/HREF=\"(.+)\"/) { + $url = $1; + } + if (/>(.+)<\/A/) { + $name=$1; + $name =~ s/\"/"e;/g; + $name =~ s/—/-/g; + $name =~ s/^\s*-?\s*//g; + $name =~ s/\.$//g; +# print "NAME $name\n"; + } + + if ($b3 =~ />
<\/DL/i) { + $depth--; + print " "x($depth-1) . "\n" if ($depth != $initialdepth-1); + $b3=$b2; + $b2=$b1; + $b1=$_; + next; + } + + if ($b3 =~ />.*<\/DT/i && $name ne "" && $url ne "") { + if ($b1 =~ />
\n"; + } else { + print " "x($depth-1) . "\n"; + } + } + + # a simulated delay line with 6 cells + $b3=$b2; + $b2=$b1; + $b1=$_; +} diff --git a/doc/tools/toc-gsdoc b/doc/tools/toc-gsdoc new file mode 100644 index 00000000..69785d91 --- /dev/null +++ b/doc/tools/toc-gsdoc @@ -0,0 +1,24 @@ +#!/usr/bin/perl + +use Getopt::Long; + +my $prefix = ''; +GetOptions( 'title=s' => \$title, + 'main=s' => \$main ) || die "Wrong options\n"; + +$file = $ARGV[0]; +open(FILE, "$file") || die "File not found: $file\n"; + +print "\n"; + +while () { + + if (/\\(.+)\<\/uref\>\<\/item\>/) { + $name = $1; + $url = "$1.html"; + print " \n"; + } + +} + +print "\n"; diff --git a/doc/tools/toc-python b/doc/tools/toc-python new file mode 100644 index 00000000..c91cdcf2 --- /dev/null +++ b/doc/tools/toc-python @@ -0,0 +1,57 @@ +#!/usr/bin/perl + +use Getopt::Long; + +my $prefix = ''; +GetOptions( 'prefix=s' => \$prefix, + 'title=s' => \$title, + 'main=s' => \$main ) || die "Wrong options\n"; + +$file = $ARGV[0]; +open(FILE, "$file") || die "File not found: $file\n"; + +$prevdepth = 1; +$depth = 1; +print ") { + + if (/^\s*href/ && !/.*\<\/A\>$/i) { + chop; + $_ = $_ . ; + } + if (/\/i) { + $depth++; + } elsif (/\<\/UL\>/i) { + print "/" if ($prevdepth == $depth); + $depth--; + print ">\n(.+)\<\/A\>$/i) { + $url = "$prefix/$1"; + $name = dehtml($2); + $name =~ s/\s+/ /g; + print "/" if ($prevdepth == $depth); + print ">\n\n"; +close(FILE); + +sub dehtml +{ + my ( $str ) = @_; + + $str =~ s/\<(tt|b) class=\"([^\"]*)\"\>//g; + $str =~ s/\<\/(tt|b)\>//g; + $str =~ s/\//g; + $str =~ s/\<\/i\>//g; + + return $str; +} + +# Local Variables: +# mode: perl +# fill-column: 120 +# End: diff --git a/doc/tools/toc-texi b/doc/tools/toc-texi new file mode 100755 index 00000000..2be48fa6 --- /dev/null +++ b/doc/tools/toc-texi @@ -0,0 +1,47 @@ +#!/usr/bin/perl + +# Copyright (C) 2001 by Claudiu Costin +# +# +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 2 of the License, or +# (at your option) any later version. + +$depth=0; +$buffer=""; + +while (<>) { + chop; + + if ($buffer =~ /
    /i) { + $depth++; + $buffer = $_; + next; + } + if ($buffer =~ /<\/ul>/i) { + $depth--; + print " "x($depth-1) . "\n" if ($depth != 0); + $buffer = $_; + next; + } + + if ($buffer =~ /
  • /i) { + $buffer =~ /HREF=\"([^\"]+)\"/; + $url=$1; + $buffer =~ /\">(.+)<\/A>/; + $text=$1; + $text =~ s///gi; + $text =~ s/<\/tt>//gi; + $text =~ s///gi; + $text =~ s/<\/CODE>//gi; + $text =~ s/
    //gi; + if (/
      /i) { + print " "x($depth-1) . "\n"; + } else { + print " "x($depth-1) . "\n"; + } + } + # a simulated delay line with one cell + $buffer = $_; +} -- cgit v1.2.1