[prev in list] [next in list] [prev in thread] [next in thread]
List: kde-devel
Subject: [patch] request for review - apidox for kdelibs/kdeui (long)
From: Brad Hards <bhards () bigpond ! net ! au>
Date: 2003-09-07 6:46:49
[Download RAW message or body]
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1
G'day,
As part of the KDE developers book, I'm thinking that we should clean up the
API reference documentation. I'm not sure about a lot of things, so I'm
working this in stages. Stage 1 starts here.
The changes below are from kdelibs/kdeui. They are intended to clean up the
"make apidox" output in preparation for subsequent changes and review. The
idea is that "make apidox" should build cleanly, so it is easier to find any
regression, and that is what the diff below does.
There are four sorts of changes:
1. #ifdef in some .cpp files to make the implementation match the interface
2. Fixes for some missing entries
3. Placeholders for the rest of the missing entries
4. Minor fixups / reformatting that occurred in the process of the first
three.
I'm mostly worried about the first set of changes, because I don't fully
understand the intent of the #ifndef KDE_NO_COMPAT macro, and I worry about
binary incompatible changes.
I'm not planning on committing this for at least a week, to provide a bit of
time for those recovering from N7Y, but feedback soon would be good, because
I'm going to be away (no email after 2200 UTC monday night), and I'd like to
fix up any issues, and build on this round of changes.
Brad
Index: kaboutapplication.h
===================================================================
RCS file: /home/kde/kdelibs/kdeui/kaboutapplication.h,v
retrieving revision 1.5
diff -u -4 -p -r1.5 kaboutapplication.h
- --- kaboutapplication.h 16 Aug 2003 19:45:00 -0000 1.5
+++ kaboutapplication.h 7 Sep 2003 06:35:15 -0000
@@ -26,18 +26,19 @@
#include <kaboutdata.h>
#include <kaboutdialog.h>
/**
- - * This class provides the standard "About Application" dialog box that
- - * is used by KHelpMenu. It uses the information of the global
- - * KAboutData that is specified at the start of you program in
- - * main(). Normally you should not use this class directly but
- - * rather the KHelpMenu class or even better just subclass your
- - * toplevel window from KMainWindow. If you do the latter, the help
- - * menu and thereby this dialog box is available through the
+ * @short Standard "About Application" dialog box.
+ *
+ * This class provides the standard "About Application" dialog box
+ * that is used by KHelpMenu. It uses the information of the global
+ * KAboutData that is specified at the start of your program in
+ * main(). Normally you should not use this class directly but rather
+ * the KHelpMenu class or even better just subclass your toplevel
+ * window from KMainWindow. If you do the latter, the help menu and
+ * thereby this dialog box is available through the
* KMainWindow::helpMenu() function.
*
- - * @short Standard "About Application" dialog box.
* @author Waldo Bastian (bastian@kde.org) and Espen Sand (espen@kde.org)
* @version $Id
*/
@@ -59,9 +60,9 @@ class KAboutApplication : public KAboutD
*/
KAboutApplication( QWidget *parent=0, const char *name=0, bool
modal=true );
/**
- - * Constructor. Mostly does the same stuff as the above constructor,
except
+ * Constructor. Mostly does the same stuff as the previous constructor,
except
* that it can take a custom KAboutData object instead of the one
specified
* in your main() function. This is especially useful for applications
* which are implemented as (dynamically loaded) libraries, e.g. panel
* applets.
Index: kaction.cpp
===================================================================
RCS file: /home/kde/kdelibs/kdeui/kaction.cpp,v
retrieving revision 1.312
diff -u -4 -p -r1.312 kaction.cpp
- --- kaction.cpp 3 Jun 2003 20:47:33 -0000 1.312
+++ kaction.cpp 7 Sep 2003 06:35:15 -0000
@@ -473,12 +473,14 @@ void KAction::removeKAccel( KAccel* kacc
}
}
// KDE 4: remove
+#ifndef KDE_NO_COMPAT
void KAction::setAccel( int keyQt )
{
setShortcut( KShortcut(keyQt) );
}
+#endif
// KDE 4: remove end
void KAction::updateShortcut( int i )
{
@@ -536,12 +538,14 @@ void KAction::setShortcutText( const QSt
{
setShortcut( KShortcut(s) );
}
+#ifndef KDE_NO_COMPAT
int KAction::accel() const
{
return d->m_cut.keyCodeQt();
}
+#endif
void KAction::setGroup( const QString& grp )
{
d->m_group = grp;
Index: kaction.h
===================================================================
RCS file: /home/kde/kdelibs/kdeui/kaction.h,v
retrieving revision 1.176
diff -u -4 -p -r1.176 kaction.h
- --- kaction.h 30 Aug 2003 08:23:29 -0000 1.176
+++ kaction.h 7 Sep 2003 06:35:15 -0000
@@ -55,8 +55,10 @@ class KActionCollection;
class KPopupMenu;
class KMainWindow;
/**
+ * @short Class to encapsulate user-driven action or event
+ *
* The KAction class (and derived and super classes) provides a way to
* easily encapsulate a "real" user-selected action or event in your
* program.
*
@@ -196,9 +198,8 @@ class KMainWindow;
* have to plug your actions into containers manually. The framework
* does that for you.
*
* @see KStdAction
- - * @short Class to encapsulate user-driven action or event
*/
class KAction : public QObject
{
friend class KActionCollection;
@@ -288,8 +289,13 @@ public:
* The same as the above constructor, but with a KGuiItem providing
* the text and icon.
*
* @param item The KGuiItem with the label and (optional) icon.
+ * @param cut The corresponding keyboard shortcut (shortcut).
+ * @param receiver The SLOT's parent.
+ * @param slot The SLOT to invoke to execute this action.
+ * @param parent This action's parent.
+ * @param name An internal name for this action.
*/
KAction( const KGuiItem& item, const KShortcut& cut,
const QObject* receiver, const char* slot,
KActionCollection* parent, const char* name );
@@ -343,8 +349,10 @@ public:
* toolbar. You do all enabling/disabling/manipulation directly
* with your KAction object.
*
* @param widget The GUI element to display this action
+ * @param index The position into which the action is plugged. If
+ * this is negative, the action is inserted at the end.
*/
virtual int plug( QWidget *widget, int index = -1 );
/**
@@ -596,9 +604,9 @@ public:
/**
* @deprecated. Use setToolTip instead (they do the same thing now).
*/
void setStatusText( const QString &text )
- - { setToolTip( text ); }
+ { setToolTip( text ); }`
/**
* @deprecated. for backwards compatibility.
*/
Index: kactioncollection.cpp
===================================================================
RCS file: /home/kde/kdelibs/kdeui/kactioncollection.cpp,v
retrieving revision 1.310
diff -u -4 -p -r1.310 kactioncollection.cpp
- --- kactioncollection.cpp 28 May 2003 02:49:23 -0000 1.310
+++ kactioncollection.cpp 7 Sep 2003 06:35:16 -0000
@@ -96,8 +96,9 @@ KActionCollection::KActionCollection( QW
setInstance( instance );
}
// KDE 4: remove
+#ifndef KDE_NO_COMPAT
KActionCollection::KActionCollection( QObject *parent, const char *name,
KInstance *instance )
: QObject( parent, name )
{
@@ -117,8 +118,9 @@ KActionCollection::KActionCollection( co
kdWarning(129) << "KActionCollection::KActionCollection( const
KActionCollection & ): function is severely deprecated." << endl;
d = new KActionCollectionPrivate;
*this = copy;
}
+#endif
// KDE 4: remove end
KActionCollection::~KActionCollection()
{
@@ -343,12 +345,14 @@ void KActionCollection::_clear()
while ( it.current() )
_remove( it.current() );
}
+#ifndef KDE_NO_COMPAT
void KActionCollection::insert( KAction* action ) { _insert( action ); }
void KActionCollection::remove( KAction* action ) { _remove( action ); }
KAction* KActionCollection::take( KAction* action ) { return
_take( action ); }
void KActionCollection::clear() { _clear(); }
+#endif
KAccel* KActionCollection::accel() { return kaccel(); }
const KAccel* KActionCollection::accel() const { return kaccel(); }
KAccel* KActionCollection::builderKAccel() const { return
d->m_builderKAccel; }
@@ -606,8 +610,9 @@ KAction *KActionCollection::findAction(
return 0;
}
// KDE 4: remove
+#ifndef KDE_NO_COMPAT
KActionCollection KActionCollection::operator+(const KActionCollection &c )
const
{
kdWarning(129) << "KActionCollection::operator+(): function is severely
deprecated." << endl;
KActionCollection ret( *this );
@@ -643,8 +648,9 @@ KActionCollection &KActionCollection::op
insert( it.current() );
return *this;
}
+#endif
// KDE 4: remove end
//---------------------------------------------------------------------
// KActionShortcutList
Index: kdialogbase.h
===================================================================
RCS file: /home/kde/kdelibs/kdeui/kdialogbase.h,v
retrieving revision 1.95
diff -u -4 -p -r1.95 kdialogbase.h
- --- kdialogbase.h 30 Aug 2003 08:23:29 -0000 1.95
+++ kdialogbase.h 7 Sep 2003 06:35:17 -0000
@@ -385,8 +385,11 @@ class KDialogBase : public KDialog
* program interface (example: other dialogs) is accessible
* while the dialog is open.
* @param separator If @p true, a separator line is drawn between the
* action buttons and the main widget.
+ * @param yes Text to use for the first button (defaults to i18n("Yes"))
+ * @param no Text to use for the second button (defaults to i18n("No"))
+ * @param cancel Text to use for the third button (defaults to
i18n("Cancel"))
*/
KDialogBase( const QString &caption, int buttonMask=Yes|No|Cancel,
ButtonCode defaultButton=Yes, ButtonCode escapeButton=Cancel,
QWidget *parent=0, const char *name=0,
Index: kdockwidget.h
===================================================================
RCS file: /home/kde/kdelibs/kdeui/kdockwidget.h,v
retrieving revision 1.87
diff -u -4 -p -r1.87 kdockwidget.h
- --- kdockwidget.h 26 Aug 2003 19:22:07 -0000 1.87
+++ kdockwidget.h 7 Sep 2003 06:35:17 -0000
@@ -430,8 +430,9 @@ public:
* @param pixmap An icon (for instance shown when docked centered)
* @param parent Parent widget
* @param strCaption Title of the dockwidget window (shown when toplevel)
* @param strTabPageLabel The title of the tab page (shown when in tab page
mode), if it is "", only the icon will be shown, if it is 0L, the label is
set to strCaption
+ * @param f Qt::WidgetFlags widget flags
*/
KDockWidget( KDockManager* dockManager, const char* name,
const QPixmap &pixmap, QWidget* parent = 0L, const QString&
strCaption = QString::null,
const QString& strTabPageLabel = QString::fromLatin1( " " ),
WFlags f = 0);
@@ -1255,9 +1256,9 @@ private:
* 20 ); // relation target/this (in
percent)
* ...
* \endcode
*
- - * Docking is fully dynamical at runtime. That means you can always move
dockwidgets via drag and drop.
+ * Docking is fully dynamic at runtime. That means you can always move
dockwidgets via drag and drop.
*
* And last but not least you can use the popupmenu for showing or hiding any
controlled dockwidget
* of this class and insert it to your main menu bar or anywhere else.
*
@@ -1278,9 +1279,11 @@ public:
* @li a dockmanager is created...
* @li ...and gets initialized
* @li the main dockwidget is set to 0
*
- - * @param name object name
+ * @param parent Parent widget for the dock main widget
+ * @param name internal object name
+ * @param f Qt::WidgetFlags widget flags
*/
KDockMainWindow( QWidget* parent = 0L, const char *name = 0L, WFlags f =
WType_TopLevel | WDestructiveClose );
/**
Index: kfontdialog.h
===================================================================
RCS file: /home/kde/kdelibs/kdeui/kfontdialog.h,v
retrieving revision 1.67
diff -u -4 -p -r1.67 kfontdialog.h
- --- kfontdialog.h 31 Aug 2003 01:10:53 -0000 1.67
+++ kfontdialog.h 7 Sep 2003 06:35:20 -0000
@@ -91,8 +91,9 @@ public:
* If that has not been created, X is queried, and all fonts
* available on the system are displayed.
* @param diff Display the difference version dialog.
* See KFontDialog::getFontDiff().
+ * @param makeFrame Draws a frame with titles around the contents.
* @param visibleListSize The minimum number of visible entries in the
* fontlists.
* @param sizeIsRelativeState If not zero the widget will show a
* checkbox where the user may choose whether the font size
Index: khelpmenu.h
===================================================================
RCS file: /home/kde/kdelibs/kdeui/khelpmenu.h,v
retrieving revision 1.27
diff -u -4 -p -r1.27 khelpmenu.h
- --- khelpmenu.h 17 Aug 2003 13:21:06 -0000 1.27
+++ khelpmenu.h 7 Sep 2003 06:35:20 -0000
@@ -147,9 +147,9 @@ class KHelpMenu : public QObject
* and will be centered with respect to the parent.
* @param aboutAppText User definable string that is used in the
* application specific dialog box. Note: The help menu will
* not open this dialog box if you don't define a string. See
- - * showAboutApplication() for more information.
+ * showAboutApplication() for more information.
* @param showWhatsThis Decides whether a "Whats this" entry will be
* added to the dialog.
*
*/
@@ -158,13 +158,19 @@ class KHelpMenu : public QObject
/**
* Constructor.
*
+ * This alternative constructor is mainly useful if you want to
+ * overide the standard actions (aboutApplication(), aboutKDE(),
+ * helpContents(), reportBug, and optionally whatsThis).
+ *
* @param parent The parent of the dialog boxes. The boxes are modeless
* and will be centered with respect to the parent.
* @param aboutData User and app data used in the About app dialog
* @param showWhatsThis Decides whether a "Whats this" entry will be
* added to the dialog.
+ * @param actions KActionCollection that is used instead of the
+ * standard actions.
*
*/
KHelpMenu( QWidget *parent, const KAboutData *aboutData,
bool showWhatsThis=true, KActionCollection *actions = 0 );
Index: kinputdialog.h
===================================================================
RCS file: /home/kde/kdelibs/kdeui/kinputdialog.h,v
retrieving revision 1.4
diff -u -4 -p -r1.4 kinputdialog.h
- --- kinputdialog.h 16 Aug 2003 19:45:02 -0000 1.4
+++ kinputdialog.h 7 Sep 2003 06:35:20 -0000
@@ -164,8 +164,9 @@ class KInputDialog : public KDialogBase
* @param value Initial value of the spin box
* @param minValue Minimum value user can input
* @param maxValue Maximum value user can input
* @param step Amount by which value is incremented or decremented
+ * @param decimals Number of digits after the decimal point
* @param ok This bool would be set to true if user pressed Ok
* @param parent Parent of the dialog widget
* @param name Name of the dialog widget
*
Index: kkeydialog.cpp
===================================================================
RCS file: /home/kde/kdelibs/kdeui/kkeydialog.cpp,v
retrieving revision 1.147
diff -u -4 -p -r1.147 kkeydialog.cpp
- --- kkeydialog.cpp 3 Sep 2003 15:33:17 -0000 1.147
+++ kkeydialog.cpp 7 Sep 2003 06:35:20 -0000
@@ -165,8 +165,9 @@ KKeyChooser::KKeyChooser( KShortcutList*
initGUI( type, bAllowLetterShortcuts );
insert( pList );
}
+#ifndef KDE_NO_COMPAT
KKeyChooser::KKeyChooser( KAccel* actions, QWidget* parent,
bool bCheckAgainstStdKeys,
bool bAllowLetterShortcuts,
bool bAllowWinKey )
@@ -192,8 +193,9 @@ KKeyChooser::KKeyChooser( KGlobalAccel*
initGUI( type, bAllowLetterShortcuts );
insert( actions );
}
+#endif
// list of all existing KKeyChooser's
// Used when checking global shortcut for a possible conflict
// (just checking against kdeglobals isn't enough, the shortcuts
@@ -598,8 +600,9 @@ void KKeyChooser::capturedShortcut( cons
}
// FIXME: give this functionality again -- I don't think it's ever used,
though. -- ellis
// TODO: Check lxr.kde.org to see if it's used anywhere
+#ifndef KDE_NO_COMPAT
void KKeyChooser::listSync()
{
/* kdDebug(125) << "KKeyChooser::listSync()" << endl;
@@ -613,8 +616,9 @@ void KKeyChooser::listSync()
update();
updateButtons();
}*/
}
+#endif
void KKeyChooser::syncToConfig( const QString& sConfigGroup, KConfigBase*
pConfig, bool bClearUnset )
{
kdDebug(125) << "KKeyChooser::syncToConfig( \"" << sConfigGroup <<
"\", " << pConfig << " ) start" << endl;
Index: kkeydialog.h
===================================================================
RCS file: /home/kde/kdelibs/kdeui/kkeydialog.h,v
retrieving revision 1.77
diff -u -4 -p -r1.77 kkeydialog.h
- --- kkeydialog.h 30 Aug 2003 08:23:29 -0000 1.77
+++ kkeydialog.h 7 Sep 2003 06:35:20 -0000
@@ -65,8 +65,10 @@ class KKeyChooser : public QWidget
* Constructor.
*
* @param bAllowLetterShortcuts Set to false if unmodified
alphanumeric
* keys ('A', '1', etc.) are not permissible shortcuts.
+ * @param parent
+ * @param type
**/
KKeyChooser( QWidget* parent, ActionType type = Application, bool
bAllowLetterShortcuts = true );
KKeyChooser( KActionCollection* coll, QWidget* parent, bool
bAllowLetterShortcuts = true );
KKeyChooser( KAccel* actions, QWidget* parent, bool
bAllowLetterShortcuts = true );
@@ -295,10 +297,13 @@ public:
/**
* This is an overloaded member function, provided for convenience.
* It behaves essentially like the above function.
+ * @param coll
* @param bAllowLetterShortcuts Set to false if unmodified
alphanumeric
* keys ('A', '1', etc.) are not permissible shortcuts.
+ * @param parent
+ * @param bSaveSettings
*/
static int configure( KActionCollection* coll, bool
bAllowLetterShortcuts, QWidget* parent = 0, bool bSaveSettings = true ); //
BCI: merge with bAllowLetterShortcuts = true
/**
Index: kled.h
===================================================================
RCS file: /home/kde/kdelibs/kdeui/kled.h,v
retrieving revision 1.27
diff -u -4 -p -r1.27 kled.h
- --- kled.h 30 Aug 2003 08:23:29 -0000 1.27
+++ kled.h 7 Sep 2003 06:35:20 -0000
@@ -27,8 +27,10 @@
#include <kdemacros.h>
class QColor;
/**
+ * @short An LED widget.
+ *
* Displays a round or rectangular light emitting diode.
*
* It is configurable to five colors, the two on/off states and three
* styles (or "looks");
@@ -37,9 +39,8 @@ class QColor;
* light spot or a round view sunken in the screen.
*
* \image html kled.png "KDE LED Widget"
*
- - * @short An LED widget.
* @author Joerg Habenicht, Richard J. Moore (rich@kde.org) 1998, 1999
*/
class KLed : public QWidget
{
@@ -112,8 +113,9 @@ public:
*
* @param col Initial color of the LED.
* @param state Sets the State.
* @param look Sets the Look.
+ * @param shape Sets the Shape (rectangular or circular)
* @param parent Will be handed over to QWidget.
* @param name Will be handed over to QWidget.
* @short Constructor
*/
Index: klineeditdlg.h
===================================================================
RCS file: /home/kde/kdelibs/kdeui/klineeditdlg.h,v
retrieving revision 1.16
diff -u -4 -p -r1.16 klineeditdlg.h
- --- klineeditdlg.h 17 Aug 2003 19:24:45 -0000 1.16
+++ klineeditdlg.h 7 Sep 2003 06:35:20 -0000
@@ -49,8 +49,9 @@ public:
* regexp of ".*".
*
* @param _text Text of the label
* @param _value Initial value of the inputline
+ * @param parent Parent widget for the line edit dialog
*/
KLineEditDlg( const QString& _text, const QString& _value, QWidget
*parent );
virtual ~KLineEditDlg();
@@ -84,8 +85,9 @@ public:
* @param caption Caption of the dialog
* @param text Text of the label
* @param value Initial value of the inputline
* @param ok this bool will be set to true if user pressed "Ok"
+ * @param parent The parent widget for this text input dialog
* @param validator Validator to be stuffed into the line edit.
*/
static QString getText(const QString &caption, const QString &text,
const QString& value=QString::null,
Index: kmessagebox.h
===================================================================
RCS file: /home/kde/kdelibs/kdeui/kmessagebox.h,v
retrieving revision 1.48
diff -u -4 -p -r1.48 kmessagebox.h
- --- kmessagebox.h 16 Aug 2003 19:45:02 -0000 1.48
+++ kmessagebox.h 7 Sep 2003 06:35:20 -0000
@@ -642,9 +642,9 @@ public:
* application-global modal dialog box. If @p parent is a
* widget, the message box becomes modal relative to parent.
* @param text Message string.
* @param caption Message box title. The application name is added to
- - * the title. The default title is i18n("About <appname>").
+ * the title. The default title is i18n("About \<appname
\>").
* @param options see OptionsType
*
*
* Your program wants to show some general information about the
application
Index: knuminput.h
===================================================================
RCS file: /home/kde/kdelibs/kdeui/knuminput.h,v
retrieving revision 1.54
diff -u -4 -p -r1.54 knuminput.h
- --- knuminput.h 30 Aug 2003 08:23:29 -0000 1.54
+++ knuminput.h 7 Sep 2003 06:35:22 -0000
@@ -58,9 +58,10 @@ public:
KNumInput(QWidget* parent=0, const char* name=0);
/**
* @param below A pointer to another KNumInput.
- - *
+ * @param parent
+ * @param name
*/
KNumInput(KNumInput* below, QWidget* parent=0, const char* name=0);
~KNumInput();
@@ -274,8 +275,9 @@ public:
/**
* @param min minimum value
* @param max maximum value
* @param step step size for the QSlider
+ * @param slider whether the slider is created or not
*/
void setRange(int min, int max, int step=1, bool slider=true);
/**
* Sets the minimum value.
@@ -474,9 +476,9 @@ public:
/**
* @deprecated (rounds @p value to a multiple of 1/100)
* Constructor
*
- - * puts it below other KNumInput
+ * puts it visually below other KNumInput
*
* @param below
* @param value initial value for the control
* @param parent parent QWidget
@@ -486,10 +488,17 @@ public:
/**
* Constructor
*
- - * puts it below other KNumInput
+ * the difference here is the "below" parameter. It tells this
+ * instance that it is visually put below some other KNumInput
+ * widget. Note that these two KNumInput's need not to have the
+ * same parent widget or be in the same layout group. The effect
+ * is that it'll adjust it's layout in correspondence with the
+ * layout of the other KNumInput's (you can build an arbitary long
+ * chain).
*
+ * @param below append KDoubleNumInput to the KDoubleNumInput chain
* @param lower lower boundary value
* @param upper upper boundary value
* @param value initial value for the control
* @param step step size to use for up/down arrow clicks
@@ -534,8 +543,9 @@ public:
/**
* @param min minimum value
* @param max maximum value
* @param step step size for the QSlider
+ * @param slider whether the slider is created or not
*/
void setRange(double min, double max, double step=1, bool slider=true);
/**
* Sets the minimum value.
Index: kpanelapplet.h
===================================================================
RCS file: /home/kde/kdelibs/kdeui/kpanelapplet.h,v
retrieving revision 1.35
diff -u -4 -p -r1.35 kpanelapplet.h
- --- kpanelapplet.h 30 Aug 2003 08:23:29 -0000 1.35
+++ kpanelapplet.h 7 Sep 2003 06:35:22 -0000
@@ -123,8 +123,9 @@ public:
* @param t The applet type().
* @param actions Standard RMB menu actions supported by the applet (see
action() ).
* @param parent The pointer to the parent widget handed over in the
factory function.
* @param name A Qt object name for your applet.
+ * @param f Window control flags
**/
KPanelApplet(const QString& configFile, Type t = Normal,
int actions = 0, QWidget *parent = 0, const char *name = 0,
WFlags f = 0);
Index: kpanelmenu.h
===================================================================
RCS file: /home/kde/kdelibs/kdeui/kpanelmenu.h,v
retrieving revision 1.11
diff -u -4 -p -r1.11 kpanelmenu.h
- --- kpanelmenu.h 16 Aug 2003 19:45:03 -0000 1.11
+++ kpanelmenu.h 7 Sep 2003 06:35:22 -0000
@@ -63,8 +63,10 @@ public:
KPanelMenu(QWidget *parent=0, const char *name=0);
/**
* Constructor used internally by Kicker. You don't really want to use
it.
* @param startDir a directory to associate with this menu
+ * @param parent
+ * @param name
* @see path(), setPath()
*/
KPanelMenu(const QString &startDir, QWidget *parent=0, const char
*name=0);
/**
Index: kpassdlg.h
===================================================================
RCS file: /home/kde/kdelibs/kdeui/kpassdlg.h,v
retrieving revision 1.29
diff -u -4 -p -r1.29 kpassdlg.h
- --- kpassdlg.h 31 Aug 2003 14:39:57 -0000 1.29
+++ kpassdlg.h 7 Sep 2003 06:35:22 -0000
@@ -160,8 +160,10 @@ public:
* and possible typos are detected immediately.
* @param enableKeep: if true, a check box is shown in the dialog
* which allows the user to keep his password input for later.
* @param extraBttn: allows to show additional buttons, KDialogBase.
+ * @param parent Passed to lower level constructor.
+ * @param name Passed to lower level constructor
*
* @version New in 3.0
*/
KPasswordDialog(Types type, bool enableKeep, int extraBttn,
Index: kpassivepopup.h
===================================================================
RCS file: /home/kde/kdelibs/kdeui/kpassivepopup.h,v
retrieving revision 1.15
diff -u -4 -p -r1.15 kpassivepopup.h
- --- kpassivepopup.h 21 Aug 2003 09:04:39 -0000 1.15
+++ kpassivepopup.h 7 Sep 2003 06:35:22 -0000
@@ -16,9 +16,10 @@ class QTimer;
class QLabel;
class QVBox;
/**
- - * A dialog-like popup that displays messages without interupting the user.
+ * \short A dialog-like popup that displays messages without interupting the
user.
+ *
* The simplest uses of KPassivePopup are by using the various message()
static
* methods. The position the popup appears at depends on the type of the
parent window:
*
* @li Normal Windows: The popup is placed adjacent to the icon of the
window.
@@ -98,8 +99,11 @@ public:
* keeping the look similar to the "standard" passivepopups.
*
* After customizing the widget, pass it to setView( QWidget* )
*
+ * @param caption The window caption (title) on the popup
+ * @param text The text for the popup
+ * @param icon The icon to use for the popup
* @param parent The parent widget used for the returned QVBox. If left
0L,
* then "this", i.e. the passive popup object will be used.
*
* @return a QVBox containing the given arguments, looking like the
Index: krootpixmap.h
===================================================================
RCS file: /home/kde/kdelibs/kdeui/krootpixmap.h,v
retrieving revision 1.24
diff -u -4 -p -r1.24 krootpixmap.h
- --- krootpixmap.h 3 Sep 2003 18:18:49 -0000 1.24
+++ krootpixmap.h 7 Sep 2003 06:35:22 -0000
@@ -54,8 +54,9 @@ public:
* widget is destroyed.
*
* @param target A pointer to the widget that you want to make pseudo
* transparent.
+ * @param name The internal name of the pixmap
*/
KRootPixmap( QWidget *target, const char *name=0 );
/**
Index: kseparator.h
===================================================================
RCS file: /home/kde/kdelibs/kdeui/kseparator.h,v
retrieving revision 1.11
diff -u -4 -p -r1.11 kseparator.h
- --- kseparator.h 7 Mar 2003 22:05:52 -0000 1.11
+++ kseparator.h 7 Sep 2003 06:35:22 -0000
@@ -39,10 +39,13 @@ class KSeparator : public QFrame
KSeparator(QWidget* parent=0, const char* name=0, WFlags f=0);
/**
* Constructor.
*
- - * @param orientation Set the orientation of the separator.
- - * Possible values are HLine or Horizontal and VLine or Vertical.
+ * @param orientation Set the orientation of the separator. Possible
+ * values are HLine or Horizontal and VLine or Vertical.
+ * @param parent
+ * @param name
+ * @param f
**/
KSeparator(int orientation, QWidget* parent=0, const char* name=0,
WFlags f=0);
Index: kstatusbar.h
===================================================================
RCS file: /home/kde/kdelibs/kdeui/kstatusbar.h,v
retrieving revision 1.37
diff -u -4 -p -r1.37 kstatusbar.h
- --- kstatusbar.h 30 Aug 2003 08:23:29 -0000 1.37
+++ kstatusbar.h 7 Sep 2003 06:35:22 -0000
@@ -110,8 +110,9 @@ public:
*
* If @p permanent is true, then item will be placed on the far right of
* the statusbar and will never be hidden by QStatusBar::message.
*
+ * @param text The label's text string.
* @param id id of item
* @param stretch stretch passed to QStatusBar::addWidget
* @param permanent is item permanent or not (passed to
QStatusBar::addWidget )
*
@@ -123,9 +124,11 @@ public:
/**
* Inserts a fixed width text label into status bar. The width will be set
* according to @p text, but will remain fixed even if you change text.
* You can change fixed width by calling setItemFixed.
- - * @param id id ov item
+ *
+ * @param text The label's text string
+ * @param id id of item
* @param permanent permanent flag passed to QStatusBar::addWidget
*/
inline void insertFixedItem(const QString& text, int id, bool
permanent=false)
{ insertItem(text, id, 0, permanent); setItemFixed(id); }
@@ -142,8 +145,9 @@ public:
*
* The item will be resized to fit the text. If you change text to be
empty,
* item will not be visible (untill you add some text).
*
+ * @param text The label's text string
* @param id The id of item.
*/
void changeItem( const QString& text, int id );
Index: kstdaction.h
===================================================================
RCS file: /home/kde/kdelibs/kdeui/kstdaction.h,v
retrieving revision 1.40
diff -u -4 -p -r1.40 kstdaction.h
- --- kstdaction.h 21 Aug 2003 08:17:27 -0000 1.40
+++ kstdaction.h 7 Sep 2003 06:35:22 -0000
@@ -203,9 +203,12 @@ namespace KStdAction
KAction *open(const QObject *recvr, const char *slot,
KActionCollection* parent, const char *name = 0 );
/**
* Open a recently used document.
+ * @param recvr
* @param slot The SLOT to invoke when a URL is selected.
+ * @param parent
+ * @param name
* Its signature is of the form slotURLSelected( const KURL & ).
*/
KRecentFilesAction *openRecent(const QObject *recvr, const char *slot,
KActionCollection* parent, const char *name = 0 );
Index: kstringvalidator.h
===================================================================
RCS file: /home/kde/kdelibs/kdeui/kstringvalidator.h,v
retrieving revision 1.5
diff -u -4 -p -r1.5 kstringvalidator.h
- --- kstringvalidator.h 16 Aug 2003 19:45:03 -0000 1.5
+++ kstringvalidator.h 7 Sep 2003 06:35:22 -0000
@@ -65,8 +65,11 @@ public:
* @param list The list of strings to (dis)allow.
* @param rejecting Selects the validator's mode
* (rejecting: true; accepting: false)
* @param fixupEnabled Selects whether to fix strings or not.
+ * @param parent Passed to lower level constructor.
+ * @param name Passed to lower level constructor
+ *
**/
KStringListValidator( const QStringList & list=QStringList(),
bool rejecting=true, bool fixupEnabled=false,
QObject * parent=0, const char * name=0 )
Index: ktoolbar.h
===================================================================
RCS file: /home/kde/kdelibs/kdeui/ktoolbar.h,v
retrieving revision 1.172
diff -u -4 -p -r1.172 ktoolbar.h
- --- ktoolbar.h 30 Aug 2003 08:23:29 -0000 1.172
+++ ktoolbar.h 7 Sep 2003 06:35:22 -0000
@@ -75,8 +75,10 @@ private:
};
/**
+ * @short Floatable toolbar with auto resize.
+ *
* A KDE-style toolbar.
*
* KToolBar can be dragged around in and between different docks.
*
@@ -93,9 +95,8 @@ private:
* KToolBar uses a global config group to load toolbar settings on
* construction. It will reread this config group on a
* KApplication::appearanceChanged() signal.
*
- - * @short Floatable toolbar with auto resize.
* @version $Id: ktoolbar.h,v 1.172 2003/08/30 08:23:29 raabe Exp $
* @author Reginald Stadlbauer <reggie@kde.org>, Stephan Kulow
<coolo@kde.org>, Sven Radej <radej@kde.org>.
*/
@@ -196,17 +197,18 @@ public:
* @param icon The name of the icon to use as the active pixmap
* @param id The id of this button
* @param enabled Enable or disable the button at startup
* @param text The tooltip or toolbar text (depending on state)
- - * @param index The position of the button. (-1 = at end).
+ * @param index The position of the button. (-1 = at end).
+ * @param _instance
*
* @return The item index.
*/
int insertButton(const QString& icon, int id, bool enabled = true,
const QString& text = QString::null, int index=-1,
KInstance *_instance = KGlobal::instance());
- - /**
+ /**
* This is the same as above, but with specified signals and
* slots to which this button will be connected.
*
* You can add more signals with addConnection().
@@ -214,11 +216,13 @@ public:
* @param icon The name of the icon to use as the active pixmap
* @param id The id of this button
* @param signal The signal to connect to
* @param receiver The slot's parent
+ * @param slot The slot to receive the signal specified in that
argument.
* @param enabled Enable or disable the button at startup
* @param text The tooltip or toolbar text (depending on state)
* @param index The position of the button. (-1 = at end).
+ * @param _instance
*
* @return The item index.
*/
int insertButton(const QString& icon, int id, const char *signal,
@@ -262,8 +266,9 @@ public:
* @param pixmap The name of the icon to use as the active pixmap
* @param id The id of this button
* @param signal The signal to connect to
* @param receiver The slot's parent
+ * @param slot The slot to receive the signal specified in that
argument.
* @param enabled Enable or disable the button at startup
* @param text The tooltip or toolbar text (depending on state)
* @param index The position of the button. (-1 = at end).
*
Index: ktoolbarbutton.cpp
===================================================================
RCS file: /home/kde/kdelibs/kdeui/ktoolbarbutton.cpp,v
retrieving revision 1.75
diff -u -4 -p -r1.75 ktoolbarbutton.cpp
- --- ktoolbarbutton.cpp 28 Aug 2003 08:37:22 -0000 1.75
+++ ktoolbarbutton.cpp 7 Sep 2003 06:35:23 -0000
@@ -283,9 +283,9 @@ void KToolBarButton::setIconSet( const Q
{
QToolButton::setIconSet( iconset );
}
- -// remove?
+#ifndef KDE_NO_COMPAT
void KToolBarButton::setPixmap( const QPixmap &pixmap )
{
if( pixmap.isNull()) // called by QToolButton
{
@@ -337,8 +337,9 @@ void KToolBarButton::setDisabledIcon( co
d->m_iconSize );
set.setPixmap( pm, QIconSet::Automatic, QIconSet::Disabled );
QToolButton::setIconSet( set );
}
+#endif
QPopupMenu *KToolBarButton::popup()
{
// obsolete
Index: ktoolbarbutton.h
===================================================================
RCS file: /home/kde/kdelibs/kdeui/ktoolbarbutton.h,v
retrieving revision 1.33
diff -u -4 -p -r1.33 ktoolbarbutton.h
- --- ktoolbarbutton.h 30 Aug 2003 08:23:29 -0000 1.33
+++ ktoolbarbutton.h 7 Sep 2003 06:35:23 -0000
@@ -56,8 +56,9 @@ public:
* @param id Id of this button
* @param parent This button's parent
* @param name This button's internal name
* @param txt This button's text (in a tooltip or otherwise)
+ * @param _instance
*/
KToolBarButton(const QString& icon, int id, QWidget *parent,
const char *name=0L, const QString &txt=QString::null,
KInstance *_instance = KGlobal::instance());
@@ -219,8 +220,9 @@ public:
* you press the button. Use setDelayedPopup if you want that
* behavior.
*
* @param p The new popup menu
+ * @param unused Has no effect - ignore it.
*/
void setPopup (QPopupMenu *p, bool unused = false);
/**
@@ -230,8 +232,9 @@ public:
* The popup menu is then only displayed when the button is pressed and
* held down for about half a second.
*
* @param p the new popup menu
+ * @param unused Has no effect - ignore it.
*/
void setDelayedPopup(QPopupMenu *p, bool unused = false);
/**
Index: kurllabel.h
===================================================================
RCS file: /home/kde/kdelibs/kdeui/kurllabel.h,v
retrieving revision 1.26
diff -u -4 -p -r1.26 kurllabel.h
- --- kurllabel.h 21 Aug 2003 09:04:39 -0000 1.26
+++ kurllabel.h 7 Sep 2003 06:35:23 -0000
@@ -26,9 +26,9 @@ class QColor;
class QCursor;
class QPixmap;
/**
- - * A label class that supports displaying an active hyperlink.
+ * @short A drop-in replacement for QLabel that displays hyperlinks.
*
* KURLLabel is a drop-in replacement for QLabel that handles text
* in a fashion similar to how an HTML widget handles hyperlinks. The
* text can be underlined (or not) and set to different colors. It
@@ -55,9 +55,8 @@ class QPixmap;
* as its argument.
*
* \image html kurllabel.png "KDE URL Label"
*
- - * @short A drop-in replacement for QLabel that displays hyperlinks.
* @author Kurt Granroth <granroth@kde.org> (Interface)
* @author Peter Putzer <putzer@kde.org> (Rewrite)
* @version $Id: kurllabel.h,v 1.26 2003/08/21 09:04:39 coolo Exp $
*
@@ -87,10 +86,13 @@ public:
*
* @param url is the URL emitted when the label is clicked.
* @param text is the displayed string. If it's equal to QString::null
* the @p url will be used instead.
+ * @param parent Passed to lower level constructor
+ * @param name Passed to lower level constructor
*
- - * @p parent and @p name are passed to QLabel.
+ * @p parent and @p name are passed to QLabel, which in turn passes
+ * them further down
*/
KURLLabel (const QString& url, const QString& text = QString::null,
QWidget* parent = 0L, const char* name = 0L);
Index: kxmlguibuilder.h
===================================================================
RCS file: /home/kde/kdelibs/kdeui/kxmlguibuilder.h,v
retrieving revision 1.14
diff -u -4 -p -r1.14 kxmlguibuilder.h
- --- kxmlguibuilder.h 19 Aug 2003 10:01:03 -0000 1.14
+++ kxmlguibuilder.h 7 Sep 2003 06:35:23 -0000
@@ -63,8 +63,9 @@ class KXMLGUIBuilder
* into the parent container/widget
* @param element The element from the DOM tree describing the
* container (use it to access container specified
* attributes or child elements)
+ * @param id
*/
virtual QWidget *createContainer( QWidget *parent, int index,
const QDomElement &element, int &id );
Index: kxmlguiclient.h
===================================================================
RCS file: /home/kde/kdelibs/kdeui/kxmlguiclient.h,v
retrieving revision 1.45
diff -u -4 -p -r1.45 kxmlguiclient.h
- --- kxmlguiclient.h 29 Aug 2003 10:20:37 -0000 1.45
+++ kxmlguiclient.h 7 Sep 2003 06:35:23 -0000
@@ -278,8 +278,9 @@ protected:
* @param file Either an absolute path for the file, or simply the
* filename, which will then be assumed to be installed
* in the "data" resource, under a directory named like
* the instance.
+ * @param merge Whether to merge with the global document.
* @param setXMLDoc Specify whether to call setXML. Default is true.
* and the DOM document at once.
**/
virtual void setXMLFile( const QString& file, bool merge = false, bool
setXMLDoc = true );
Index: kxmlguifactory.h
===================================================================
RCS file: /home/kde/kdelibs/kdeui/kxmlguifactory.h,v
retrieving revision 1.76
diff -u -4 -p -r1.76 kxmlguifactory.h
- --- kxmlguifactory.h 17 Aug 2003 19:24:46 -0000 1.76
+++ kxmlguifactory.h 7 Sep 2003 06:35:23 -0000
@@ -128,8 +128,10 @@ class KXMLGUIFactory : public QObject
* \endcode
* where @p "my_popup" is the name of the menu in the XMLUI file, and
* @p "this" is XMLGUIClient which owns the popupmenu (e.g. the mainwindow,
or the part, or the plugin...)
*
+ * @param containerName Name of the container widget
+ * @param client Owner of the container widget
* @param useTagName Specifies whether to compare the specified name with
the name attribute or
* the tag name.
*
* This method may return 0L if no container with the given name exists or
is not owned by the client.
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.0.7 (GNU/Linux)
iD8DBQE/WtRkW6pHgIdAuOMRAm8bAJ45/vFBKr9UL+dgSCskkm1h9W5i2ACfc8Lu
/dwIEWD8pJc8nY1BoSSIewk=
=Mc+K
-----END PGP SIGNATURE-----
>> Visit http://mail.kde.org/mailman/listinfo/kde-devel#unsub to unsubscribe <<
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic