summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorTimothy Pearson <kb9vqf@pearsoncomputing.net>2013-02-01 15:15:35 -0600
committerTimothy Pearson <kb9vqf@pearsoncomputing.net>2013-02-01 15:15:35 -0600
commitf78eb03afb8c9a380985d26286afc40b4c89b292 (patch)
tree3c087e2f119e645c902958c3bc3c802abf078ad0 /doc
parentda1941ccadffe5ae70ee111c53f0ec2b3d990869 (diff)
downloadtdevelop-f78eb03afb8c9a380985d26286afc40b4c89b292.tar.gz
tdevelop-f78eb03afb8c9a380985d26286afc40b4c89b292.zip
Rename a number of classes to enhance compatibility with KDE4
Diffstat (limited to 'doc')
-rw-r--r--doc/api/FutureTasks.dox2
-rw-r--r--doc/kde_app_devel/index.docbook24
-rw-r--r--doc/kdearch/index.docbook38
-rw-r--r--doc/tdevelop/getting-started.docbook20
4 files changed, 42 insertions, 42 deletions
diff --git a/doc/api/FutureTasks.dox b/doc/api/FutureTasks.dox
index c738a3f3..1d7f7f26 100644
--- a/doc/api/FutureTasks.dox
+++ b/doc/api/FutureTasks.dox
@@ -53,7 +53,7 @@
- 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,
+ - any menu item should be a TDEAction plugged into TDEPopupMenu, 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
diff --git a/doc/kde_app_devel/index.docbook b/doc/kde_app_devel/index.docbook
index f5af2265..c1ed3ba9 100644
--- a/doc/kde_app_devel/index.docbook
+++ b/doc/kde_app_devel/index.docbook
@@ -749,7 +749,7 @@ the compilation phase.
-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'
+31 kscribble.cpp:107: warning: unused variable `TDEAction*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' \
@@ -912,14 +912,14 @@ added some KDE methods that set program and author information for this applicat
Let's have a look at the constructor and see how this instance is called
<programlisting>
1 KScribble::KScribble()
-2 : KMainWindow( 0, "KScribble" ),
+2 : TDEMainWindow( 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
+9 // tell the TDEMainWindow that this is indeed the main widget
10 setCentralWidget(m_view);
11
12 // then, setup our actions
@@ -938,7 +938,7 @@ Let's have a look at the constructor and see how this instance is called
</programlisting>
</para>
<para>
-Notice that <classname>KScribble</classname> inherits the <classname>KMainWindow</classname> class - a
+Notice that <classname>KScribble</classname> inherits the <classname>TDEMainWindow</classname> class - a
commonly used base class for TDE applications. We initialize a class called <classname>KScribbleView</classname>
as our central widget, create a <classname>KStatusBar</classname> via the <methodname>statusBar()</methodname>
method (line 16), and connect some signals and slots together.
@@ -1123,7 +1123,7 @@ The KDE libraries were invented to make designing applications for the K Desktop
and capable of more functionality than what Qt alone is offering. The tdeui library offers:
<orderedlist>
<listitem><para>
-KListView: a more powerful version of <classname>QListView</classname>
+TDEListView: a more powerful version of <classname>QListView</classname>
</para></listitem>
<listitem><para>
KIconView: a graphical viewer of icon files
@@ -1164,9 +1164,9 @@ icons or provide quick access methods like combos to select values.
<sect1 id="c5s2">
<title>How does it work?</title>
<para>
-Our application inherits the <classname>KMainWindow</classname> class, which automatically handles creating
+Our application inherits the <classname>TDEMainWindow</classname> class, which automatically handles creating
a menu bar and tool bars for us. In the <methodname>KScribble::setupActions()</methodname> method there is
-a call to <methodname>KMainWindow::createGUI()</methodname>. This method loads a resource file, in this
+a call to <methodname>TDEMainWindow::createGUI()</methodname>. 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:
<programlisting>
@@ -1192,7 +1192,7 @@ a large number of <methodname>insertItem()</methodname> methods which allow you
menu bar.
</para>
<para>
-<classname>KMainWindow</classname>'s methods <methodname>statusBar()</methodname> and <methodname>
+<classname>TDEMainWindow</classname>'s methods <methodname>statusBar()</methodname> and <methodname>
toolBar()</methodname> will also provide you with applicable widgets.
</para>
</sect1>
@@ -1202,7 +1202,7 @@ toolBar()</methodname> will also provide you with applicable widgets.
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 <classname>
-KAction</classname>, which provides the keyboard accelerator keys and access to global configured
+TDEAction</classname>, which provides the keyboard accelerator keys and access to global configured
standard keyboard accelerators.
</para>
<para>
@@ -1249,7 +1249,7 @@ Within the application, those are:</para>
<para>
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
-<classname>KMainWindow</classname> class, though as the author you must provide the content.
+<classname>TDEMainWindow</classname> class, though as the author you must provide the content.
</para>
<para>
As &tdevelop; also offers all types of help as well as the KDE framework generated by the
@@ -1273,7 +1273,7 @@ as possible because toolbars can be configured to display their contents in vari
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 <classname>KToolBar</classname> class reference located
+combo boxes. For a complete reference, see the <classname>TDEToolBar</classname> class reference located
in the tdeui library.
</para>
<para>
@@ -1291,7 +1291,7 @@ provided by Qt. An example of that would be:
<sect1 id="c8s3">
<title>Extending the Statusbar</title>
<para>
-As the applications that inherit <classname>KMainWindow</classname> contain a statusbar as well,
+As the applications that inherit <classname>TDEMainWindow</classname> 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
diff --git a/doc/kdearch/index.docbook b/doc/kdearch/index.docbook
index 53e7ff7a..7f035d77 100644
--- a/doc/kdearch/index.docbook
+++ b/doc/kdearch/index.docbook
@@ -285,13 +285,13 @@ throughout the desktop.
<itemizedlist>
-<listitem><formalpara><title><ulink url="kdeapi:tdecore/KAccel">KAccel</ulink></title>
+<listitem><formalpara><title><ulink url="kdeapi:tdecore/TDEAccel">TDEAccel</ulink></title>
<para>
Collection of keyboard shortcuts.
</para>
</formalpara></listitem>
-<listitem><formalpara><title><ulink url="kdeapi:tdecore/KStdAccel">KStdAccel</ulink></title>
+<listitem><formalpara><title><ulink url="kdeapi:tdecore/TDEStdAccel">TDEStdAccel</ulink></title>
<para>
Easy access to the common keyboard shortcut keys.
</para>
@@ -401,25 +401,25 @@ Widgets - widget classes for list views, rules, color selection etc.
<itemizedlist>
-<listitem><formalpara><title><ulink url="kdeapi:tdeui/KListView">KListView</ulink></title>
+<listitem><formalpara><title><ulink url="kdeapi:tdeui/TDEListView">TDEListView</ulink></title>
<para>
A variant of <classname>QListView</classname> that honors KDE's system-wide settings.
</para>
</formalpara></listitem>
-<listitem><formalpara><title><ulink url="kdeapi:tdeui/KListView">KListBox</ulink></title>
+<listitem><formalpara><title><ulink url="kdeapi:tdeui/TDEListView">TDEListBox</ulink></title>
<para>
A variant of <classname>QListBox</classname> that honors KDE's system-wide settings.
</para>
</formalpara></listitem>
-<listitem><formalpara><title><ulink url="kdeapi:tdeui/KListView">KIconView</ulink></title>
+<listitem><formalpara><title><ulink url="kdeapi:tdeui/TDEListView">KIconView</ulink></title>
<para>
A variant of <classname>QIconView</classname> that honors KDE's system-wide settings.
</para>
</formalpara></listitem>
-<listitem><formalpara><title><ulink url="kdeapi:tdeui/KListView">KLineEdit</ulink></title>
+<listitem><formalpara><title><ulink url="kdeapi:tdeui/TDEListView">KLineEdit</ulink></title>
<para>
A variant of <classname>QLineEdit</classname> with completion support.
</para>
@@ -431,7 +431,7 @@ A variant of <classname>QComboBox</classname> with completion support.
</para>
</formalpara></listitem>
-<listitem><formalpara><title><ulink url="kdeapi:tdeui/KFontCombo">KFontCombo</ulink></title>
+<listitem><formalpara><title><ulink url="kdeapi:tdeui/TDEFontCombo">TDEFontCombo</ulink></title>
<para>
A combo box for selecting fonts.
</para>
@@ -506,7 +506,7 @@ A color selection dialog.
</para>
</formalpara></listitem>
-<listitem><formalpara><title><ulink url="kdeapi:tdeui/KFontDialog">KFontDialog</ulink></title>
+<listitem><formalpara><title><ulink url="kdeapi:tdeui/TDEFontDialog">TDEFontDialog</ulink></title>
<para>
A font selection dialog.
</para>
@@ -574,13 +574,13 @@ Actions and XML GUI
<itemizedlist>
-<listitem><formalpara><title><ulink url="kdeapi:tdeui/KAction">KAction</ulink></title>
+<listitem><formalpara><title><ulink url="kdeapi:tdeui/TDEAction">TDEAction</ulink></title>
<para>
Abstraction for an action that can be plugged into menu bars and tool bars.
</para>
</formalpara></listitem>
-<listitem><formalpara><title><ulink url="kdeapi:tdeui/KActionCollection">KActionCollection</ulink></title>
+<listitem><formalpara><title><ulink url="kdeapi:tdeui/TDEActionCollection">TDEActionCollection</ulink></title>
<para>
A set of actions.
</para>
@@ -1366,7 +1366,7 @@ come from many different plugins or parts.
<para>
KDE's class for toplevel windows,
-<ulink url="kdeapi:tdeui/KMainWindow.html">KMainWindow</ulink>,
+<ulink url="kdeapi:tdeui/TDEMainWindow.html">TDEMainWindow</ulink>,
inherits
<ulink url="kdeapi:tdeui/KXMLGUIClient.html">KXMLGUIClient</ulink>
and therefore supports XMLGUI out of the box. All actions created within it must
@@ -1423,19 +1423,19 @@ 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("&amp;Half size"), ALT+Key_0,
+ new TDEAction ( i18n("&amp;Half size"), ALT+Key_0,
this, SLOT(slotHalfSize()),
actionCollection(), "zoom50" );
- new KAction ( i18n("&amp;Normal size"), ALT+Key_1,
+ new TDEAction ( i18n("&amp;Normal size"), ALT+Key_1,
this, SLOT(slotDoubleSize()),
actionCollection(), "zoom100" );
- new KAction ( i18n("&amp;Double size"), ALT+Key_2,
+ new TDEAction ( i18n("&amp;Double size"), ALT+Key_2,
this, SLOT(slotDoubleSize()),
actionCollection(), "zoom200" );
- new KAction ( i18n("&amp;Fill Screen"), ALT+Key_3,
+ new TDEAction ( i18n("&amp;Fill Screen"), ALT+Key_3,
this, SLOT(slotFillScreen()),
actionCollection(), "zoomMaxpect" );
- new KAction ( i18n("Fullscreen &amp;Mode"), CTRL+SHIFT+Key_F,
+ new TDEAction ( i18n("Fullscreen &amp;Mode"), CTRL+SHIFT+Key_F,
this, SLOT(slotFullScreen()),
actionCollection(), "fullscreen" );
</programlisting>
@@ -1623,7 +1623,7 @@ void MainWindow::updateOpenWithActions()
unplugActionList("openwith");
openWithActions.clear();
for ( /* iterate over the relevant services */ ) {
- KAction *action = new KAction( ...);
+ TDEAction *action = new TDEAction( ...);
openWithActions.append(action);
}
plugActionList("openwith", openWithActions);
@@ -1769,11 +1769,11 @@ QToolTip::add(w, i18n("This widget does something."))
<para>
If the menu bars and tool bars are created using the <ulink url="actionpattern.html">
action pattern</ulink>, the string used as tooltip is derived from the first argument
-of the <ulink url="kdeapi:tdeui/KAction.html">KAction</ulink> constructor:
+of the <ulink url="kdeapi:tdeui/TDEAction.html">TDEAction</ulink> constructor:
</para>
<programlisting>
-action = new KAction(i18n("&amp;Delete"), "editdelete",
+action = new TDEAction(i18n("&amp;Delete"), "editdelete",
SHIFT+Key_Delete, actionCollection(), "del")
</programlisting>
diff --git a/doc/tdevelop/getting-started.docbook b/doc/tdevelop/getting-started.docbook
index 9a5937bd..a805f393 100644
--- a/doc/tdevelop/getting-started.docbook
+++ b/doc/tdevelop/getting-started.docbook
@@ -1426,18 +1426,18 @@ window find the following lines.</para>
<programlisting>
Hello::Hello()
- : KMainWindow( 0, "Hello" )
+ : TDEMainWindow( 0, "Hello" )
{
</programlisting>
-<para>Right click on <classname>KMainWindow</classname>.
+<para>Right click on <classname>TDEMainWindow</classname>.
A menu will pop up. There select the <guimenuitem>Search in Documentation:
-KMainWindow</guimenuitem> entry and release the mouse button. Now the
+TDEMainWindow</guimenuitem> entry and release the mouse button. Now the
<guilabel>Documentation</guilabel> tool view will open, showing the
-<classname>KMainWindow</classname> entry as search item on the
+<classname>TDEMainWindow</classname> entry as search item on the
<guilabel>Search</guilabel> sub-page. And a short while after another editor
window will open in the workspace area, showing the KDE API Reference page of
-the <classname>KMainWindow</classname> class.</para>
+the <classname>TDEMainWindow</classname> class.</para>
<para>This all will look like the following. (We deliberately opened the
<guilabel>Documentation</guilabel>, <guilabel>Search</guilabel> page already to
@@ -1454,11 +1454,11 @@ identifier.</para></caption>
</screenshot>
<para>You might as well select <guimenuitem>Find Documentation:
-KMainWindow</guimenuitem>. In this case the <guilabel>Finder</guilabel> sub-page
+TDEMainWindow</guimenuitem>. In this case the <guilabel>Finder</guilabel> sub-page
of the <guilabel>Documentation</guilabel> tool view will show up, usually
providing a selection of pages containing the search term. (In our example this
-will probably be the <classname>KMainWindow</classname> and
-<classname>KMainWindowInterface</classname> classes. Select the one you are
+will probably be the <classname>TDEMainWindow</classname> and
+<classname>TDEMainWindowInterface</classname> classes. Select the one you are
interested in and the corresponding documentation will be displayed in an editor
window.</para>
@@ -1573,7 +1573,7 @@ Hello</guilabel>, and &tdevelop; will immediately open the
front of this class definition:</para>
<programlisting>
Hello::Hello()
- : KMainWindow( 0, "Hello" )
+ : TDEMainWindow( 0, "Hello" )
{
</programlisting>
</listitem>
@@ -2127,7 +2127,7 @@ comment marks will be recognized as well.</para>
<filename>hello.cpp</filename> example file</para>
<programlisting>
Hello::Hello()
- : KMainWindow( 0, "Hello" )
+ : TDEMainWindow( 0, "Hello" )
{
// set the shell's ui resource file
// TODO check the user interface