TDEParts - Revision history

Blu256: Added collapsible box for listing

2022-06-08T09:52:34Z

Added collapsible box for listing

Blu256: Added XParts as See also

2022-06-08T09:39:59Z

Added XParts as See also

Blu256: -Applicable to TDE (redundant)

2022-04-21T15:26:48Z

-Applicable to TDE (redundant)

Blu256: /* notepadpart.rc: XML Description of the Notepad Part's User Interface */ Fixed syntax mistake

2022-04-21T13:49:21Z

notepadpart.rc: XML Description of the Notepad Part's User Interface: Fixed syntax mistake

Blu256: Add warning about not including status bar in rc file if designing for Konqueror

2022-04-21T13:20:17Z

Add warning about not including status bar in rc file if designing for Konqueror

Blu256: /* Excerpt of ghostviewtest.cpp: Implementation of the simple TDEParts main window */ small fixes

2022-02-11T16:29:19Z

Excerpt of ghostviewtest.cpp: Implementation of the simple TDEParts main window: small fixes

Blu256: Replaced more occurences of obsolete TQMultiLineEdit with TQTextEdit

2022-02-11T16:13:08Z

Replaced more occurences of obsolete TQMultiLineEdit with TQTextEdit

Blu256: /* notepad_part.h: Header of the NotepadPart Class */ TQMultiLineEdit obsolete since Qt 3.0 (see https://doc.qt.io/archives/3.3/qtextedit.html), replaced with TQTextEdit

2022-02-11T16:11:55Z

notepad_part.h: Header of the NotepadPart Class: TQMultiLineEdit obsolete since Qt 3.0 (see https://doc.qt.io/archives/3.3/qtextedit.html), replaced with TQTextEdit

Blu256: Blu256 moved page KParts (KDE3 Architecture) to TDEParts: More accurate title

2022-02-05T13:31:33Z

Blu256 moved page KParts (KDE3 Architecture) to TDEParts: More accurate title

Blu256: Updated for TDE (1 section still needs to be updated)

2021-09-17T15:26:15Z

Updated for TDE (1 section still needs to be updated)

Show changes

@@ Line 66: / Line 66: @@
 A sample XML file for a main window looks like this:
+{{Collapsible
-====''Listing 13.1 Excerpt of konqueror.rc: A User Interface Described in XML''====
+ | caption = XML TDEPart GUI example
+ | content =
 <syntaxhighlight lang="xml">
 <!DOCTYPE kpartgui SYSTEM "kpartgui.dtd">
@@ Line 106: / Line 107: @@
 </kpartgui>
 </syntaxhighlight>
+}}
 The DOCTYPE tag contains the name of the main element, which should be set to kpartgui. The top-level elements are <code>MenuBar</code> and <code>ToolBar</code>, as expected. In the <code>MenuBar</code>, the menus are described. Note that they have a name, used for merging later on, and a text, which is displayed in the user interface, possibly translated. Because this is XML, & has to be encoded as &amp;. Inside a <code>Menu</code> tag, the actions, some separators, and possibly submenus are laid out. The action names are very important because they are used to match the actions created in the code.

@@ Line 64: / Line 64: @@
 More precisely, the XML file describes the layout of the menus and submenus in the menubar (only one menubar is always present) and the menu items within those menus, as well as the toolbars and the toolbar buttons. The menubar, menus, and toolbars are containers; menu items and toolbar buttons are the actions.
-A sample XML file for a main window looks like the one shown in Listing 13.1.
+A sample XML file for a main window looks like this:
 ====''Listing 13.1 Excerpt of konqueror.rc: A User Interface Described in XML''====
@@ Line 768: / Line 768: @@
 To provide better integration with Konqueror, you can also provide a KParts::BrowserExtension for the part, as defined in <tt>tdeparts/browserextension.h</tt>. This is what makes it possible to save and restore a view in Konqueror's history and for the part to use Konqueror's "standard actions." Examples of parts using the browser extension can be found in KView, KDVI, KGhostView, KWrite and all built-in Konqueror views.
+== See also ==
+* [[XParts]], a technology which extends TDEParts to write TDE components with almost any toolkit or language or turn existing applications into TDE components quite easily.

@@ Line 2: / Line 2: @@
 [[Category:Architecture]]
 [[Category:Developers]]
-{{Applicable to TDE}}

@@ Line 221: / Line 221: @@
 {{WarningBox
- |text=If you are designing a part for integration with Konqueror, please do ***not*** add a <code>&lt;StatusBar/&gt;</code>, because Konqueror already provides a status bar. If you are writing a part for integration in both Konqueror and your own application/shell, opt to provide a status bar in your application instead.
+ |text=If you are designing a part for integration with Konqueror, please do '''not''' add a <code>&lt;StatusBar/&gt;</code>, because Konqueror already provides a status bar. If you are writing a part for integration in both Konqueror and your own application/shell, opt to provide a status bar in your application instead.
 }}

@@ Line 219: / Line 219: @@
 </kpartgui>
 </syntaxhighlight>
+{{WarningBox
+ |text=If you are designing a part for integration with Konqueror, please do ***not*** add a <code>&lt;StatusBar/&gt;</code>, because Konqueror already provides a status bar. If you are writing a part for integration in both Konqueror and your own application/shell, opt to provide a status bar in your application instead.
+}}
 An important task in the definition of a part is its constructor. It must at least define the instance, the widget, the actions, and the XML File. The constructor for this example could be as shown below:
 <!-- Listing 13.4 -->
 ==== notepad_part.cpp: Constructor ====

@@ Line 545: / Line 545: @@
   setXMLFile( "ghostviewtest_shell.rc" );
-  TDEAction * paOpen = new KAction( i18n( "&Open file" ), "fileopen", 0,
+  TDEAction * paOpen = new TDEAction( i18n( "&Open file" ), "fileopen", 0,
             this, SLOT( slotFileOpen() ), actionCollection(), "file_open" );
-  TDEAction * paQuit = new KAction( i18n( "&Quit" ), "exit", 0,
+  TDEAction * paQuit = new TDEAction( i18n( "&Quit" ), "exit", 0,
             this, SLOT( close() ), actionCollection(), "file_quit" );

@@ Line 198: / Line 198: @@
 The parent passed to the constructor is both the parent of the widget and the parent of the part itself, so that both get destroyed if the parent is destroyed. Note that having the same parent is not mandatory. If they have different parents, the framework deletes the widget if the part is destroyed and deletes the part if the widget is destroyed.
-The class members are a <tt>TQMultiLineEdit</tt> (the multi-line widget from TQt), and a <tt>TDEInstance</tt>. An instance enables access to global TDE objects, which can be different from the ones of the application. The application's configuration file and the one of any other instance is different, as well as the search paths for <code>locate()</code>, and so on. In TDEParts, this is used to locate the XML file describing the part, which is usually installed into share/apps/''instancename''/.
+The class members are a <tt>TQTextEdit</tt> (the multi-line widget from TQt), and a <tt>TDEInstance</tt>. An instance enables access to global TDE objects, which can be different from the ones of the application. The application's configuration file and the one of any other instance is different, as well as the search paths for <code>locate()</code>, and so on. In TDEParts, this is used to locate the XML file describing the part, which is usually installed into share/apps/''instancename''/.
 In addition, you define a slot, <code>slotSelectAll()</code>, to be connected to the action your part provides.
@@ Line 232: / Line 232: @@
   setInstance( instance );
-  m_edit = new TQMultiLineEdit( parent, "multilineedit" );
+  m_edit = new TQTextEdit( parent, "textedit" );
   m_edit->setFocus();
   setWidget( m_edit );
@@ Line 729: / Line 729: @@
 #include "plugin_spellcheck.h"
 #include "notepad.h" // this plugin applies to a notepad part
-#include <tqmultilineedit.h>
+#include <tqtextedit.h>
 #include <tdeaction.h>
@@ Line 747: / Line 747: @@
     {
          NotepadPart * part = (NotepadPart *) parent();
-         TQMultiLineEdit * widget = (TQMultiLineEdit *) part->widget();
+         TQTextEdit * widget = (TQTextEdit *) part->widget();
          widget->selectAll(); //selects current line !
     }
@@ Line 755: / Line 755: @@
 Note that to access the part's widget, the plug-in has to assume - and check - that it has been installed for a NotepadPart. This means that you should not install it under another part's directory. But selecting the current line in an image viewer wouldn't mean much anyway.
-A more flexible plug-in would instead check and cast the parent to ReadWritePart and then check the type of its widget to be TQMultiLineEdit.
+A more flexible plug-in would instead check and cast the parent to ReadWritePart and then check the type of its widget to be TQTextEdit.
 ==Summary==

@@ Line 170: / Line 170: @@
 #include <tdeparts/part.h>
-class TQMultiLineEdit;
+class TQTextEdit;
 class NotepadPart : public KParts::ReadWritePart
@@ Line 189: / Line 189: @@
 protected:
-  TQMultiLineEdit * m_edit;
+  TQTextEdit * m_edit;
   TDEInstance *m_instance;
 };
@@ Line 205: / Line 205: @@
 <!-- Listing 13.3 -->
 ==== notepadpart.rc: XML Description of the Notepad Part's User Interface ====