KoDialog Class Reference

A dialog base class with standard buttons and predefined layouts. More...

#include <KoDialog.h>

Inheritance diagram for KoDialog:

Public Types
enum	ButtonCode {   None = 0x00000000 , Help = 0x00000001 , Default = 0x00000002 , Ok = 0x00000004 ,   Apply = 0x00000008 , Try = 0x00000010 , Cancel = 0x00000020 , Close = 0x00000040 ,   No = 0x00000080 , Yes = 0x00000100 , Reset = 0x00000200 , Details = 0x00000400 ,   User1 = 0x00001000 , User2 = 0x00002000 , User3 = 0x00004000 , NoDefault = 0x00008000 }
enum	ButtonPopupMode { InstantPopup = 0 , DelayedPopup = 1 }
enum	CaptionFlag { NoCaptionFlags = 0 , AppNameCaption = 1 , ModifiedCaption = 2 , HIGCompliantCaption = AppNameCaption }

Public Slots
void	delayedDestruct ()
void	enableButton (ButtonCode id, bool state)
void	enableButtonApply (bool state)
void	enableButtonCancel (bool state)
void	enableButtonOk (bool state)
void	enableLinkedHelp (bool state)
bool	isDetailsWidgetVisible () const
virtual void	setCaption (const QString &caption)
virtual void	setCaption (const QString &caption, bool modified)
void	setDetailsWidget (QWidget *detailsWidget)
void	setDetailsWidgetVisible (bool visible)
void	setHelp (const QString &anchor, const QString &appname=QString())
void	setHelpLinkText (const QString &text)
virtual void	setPlainCaption (const QString &caption)

Signals
void	aboutToShowDetails ()
void	applyClicked ()
void	buttonClicked (KoDialog::ButtonCode button)
void	cancelClicked ()
void	closeClicked ()
void	defaultClicked ()
void	finished ()
void	helpClicked ()
void	hidden ()
void	layoutHintChanged ()
void	noClicked ()
void	okClicked ()
void	resetClicked ()
void	tryClicked ()
void	user1Clicked ()
void	user2Clicked ()
void	user3Clicked ()
void	yesClicked ()

Public Member Functions
QPushButton *	button (ButtonCode id) const
QIcon	buttonIcon (ButtonCode id) const
QString	buttonText (ButtonCode id) const
QString	buttonToolTip (ButtonCode id) const
QString	buttonWhatsThis (ButtonCode id) const
ButtonCode	defaultButton () const
QString	helpLinkText () const
void	incrementInitialSize (const QSize &size)
bool	isButtonEnabled (ButtonCode id) const
	KoDialog (QWidget *parent=0, Qt::WindowFlags f=Qt::WindowFlags())
QWidget *	mainWidget ()
QSize	minimumSizeHint () const override
void	setButtonFocus (ButtonCode id)
void	setButtonGuiItem (ButtonCode id, const KGuiItem &item)
void	setButtonIcon (ButtonCode id, const QIcon &icon)
void	setButtons (ButtonCodes buttonMask)
void	setButtonsOrientation (Qt::Orientation orientation)
void	setButtonText (ButtonCode id, const QString &text)
void	setButtonToolTip (ButtonCode id, const QString &text)
void	setButtonWhatsThis (ButtonCode id, const QString &text)
void	setDefaultButton (ButtonCode id)
void	setEscapeButton (ButtonCode id)
void	setInitialSize (const QSize &size)
void	setMainWidget (QWidget *widget)
void	showButton (ButtonCode id, bool state)
void	showButtonSeparator (bool state)
QSize	sizeHint () const override
	~KoDialog () override

Static Public Member Functions
static int	groupSpacingHint ()
static QString	makeStandardCaption (const QString &userCaption, QWidget *window=0, CaptionFlags flags=HIGCompliantCaption)
static int	marginHint ()
static void	resizeLayout (QLayout *lay, int margin, int spacing)
static void	resizeLayout (QWidget *widget, int margin, int spacing)
static int	spacingHint ()

Protected Slots
virtual void	slotButtonClicked (int button)

Protected Member Functions
void	closeEvent (QCloseEvent *e) override
void	hideEvent (QHideEvent *) override
void	keyPressEvent (QKeyEvent *) override
void	showEvent (QShowEvent *e) override

Private Member Functions
	KoDialog (KoDialogPrivate &dd, QWidget *parent, Qt::WindowFlags f=Qt::WindowFlags())

Private Attributes
KoDialogPrivate *const	d_ptr

Detailed Description

A dialog base class with standard buttons and predefined layouts.

Provides basic functionality needed by nearly all dialogs.

It offers the standard action buttons you'd expect to find in a dialog as well as the capability to define at most three configurable buttons. You can define a main widget that contains your specific dialog layout

The class takes care of the geometry management. You only need to define a minimum size for the widget you want to use as the main widget.

By default, the dialog is non-modal.

Standard buttons (action buttons):
You select which buttons should be displayed, but you do not choose the order in which they are displayed. This ensures a standard interface in KDE. The button order can be changed, but this ability is only available for a central KDE control tool. The following buttons are available: OK, Cancel/Close, Apply/Try, Default, Help and three user definable buttons: User1, User2 and User3. You must specify the text of the UserN buttons. Each button Q_EMIT a signal, so you can choose to connect that signal.

The default action of the Help button will open the help system if you have provided a path to the help text. The default action of Ok and Cancel will run QDialog::accept() and QDialog::reject(), which you can override by reimplementing slotButtonClicked(). The default action of the Close button will close the dialog.

Note that the KoDialog will animate a button press when the user presses Escape. The button that is enabled is either Cancel, Close or the button that is defined by setEscapeButton(). Your custom dialog code should reimplement the keyPressEvent and animate the cancel button so that the dialog behaves like regular dialogs.

Layout:
The dialog consists of a help area on top (becomes visible if you define a help path and use enableLinkedHelp()), the main area which is the built-in dialog face or your own widget in the middle and by default a button box at the bottom. The button box can also be placed at the right edge (to the right of the main widget). Use setButtonsOrientation() to control this behavior. A separator can be placed above the button box (or to the left when the button box is at the right edge).

Standard compliance:
The marginHint() and spacingHint() sizes shall be used whenever you lay out the interior of a dialog. One special note. If you make your own action buttons (OK, Cancel etc), the space between the buttons shall be spacingHint(), whereas the space above, below, to the right and to the left shall be marginHint(). If you add a separator line above the buttons, there shall be a marginHint() between the buttons and the separator and a marginHint() above the separator as well.

Example:

KoDialog *dialog = new KoDialog( this );
dialog->setCaption( "My title" );
dialog->setButtons( KoDialog::Ok | KoDialog::Cancel | KoDialog::Apply );
 
FooWidget *widget = new FooWidget( dialog );
dialog->setMainWidget( widget );
connect( dialog, SIGNAL( applyClicked() ), widget, SLOT( save() ) );
connect( dialog, SIGNAL( okClicked() ), widget, SLOT( save() ) );
connect( widget, SIGNAL( changed( bool ) ), dialog, SLOT( enableButtonApply( bool ) ) );
 
dialog->enableButtonApply( false );
dialog->show();

KDE Dialog example

This class can be used in many ways. Note that most KDE ui widgets and many of KDE core applications use the KoDialog so for more inspiration you should study the code for these.

See also

KPageDialog

Author

Thomas Tanghus tangh.nosp@m.us@e.nosp@m.arthl.nosp@m.ing..nosp@m.net

Espen Sand espen.nosp@m.sa@o.nosp@m.nline.nosp@m..no

Mirko Boehm mirko.nosp@m.@kde.nosp@m..org

Olivier Goffart <ogoffart at kde.org>

Tobias Koenig tokoe.nosp@m.@kde.nosp@m..org

Definition at line 115 of file KoDialog.h.

Member Enumeration Documentation

ButtonCode

enum KoDialog::ButtonCode

Enumerator
None
Help	Show Help button. (this button will run the help set with setHelp)
Default	Show Default button.
Ok	Show Ok button. (this button accept()s the dialog; result set to QDialog::Accepted)
Apply	Show Apply button.
Try	Show Try button.
Cancel	Show Cancel-button. (this button reject()s the dialog; result set to QDialog::Rejected)
Close	Show Close-button. (this button closes the dialog)
No	Show No button. (this button closes the dialog and sets the result to KoDialog::No)
Yes	Show Yes button. (this button closes the dialog and sets the result to KoDialog::Yes)
Reset	Show Reset button.
Details	Show Details button. (this button will show the detail widget set with setDetailsWidget)
User1	Show User defined button 1.
User2	Show User defined button 2.
User3	Show User defined button 3.
NoDefault	Used when specifying a default button; indicates that no button should be marked by default.

Definition at line 123 of file KoDialog.h.

                    {
        None    = 0x00000000,
        Help    = 0x00000001, 
        Default = 0x00000002, 
        Ok      = 0x00000004, 
        Apply   = 0x00000008, 
        Try     = 0x00000010, 
        Cancel  = 0x00000020, 
        Close   = 0x00000040, 
        No      = 0x00000080, 
        Yes     = 0x00000100, 
        Reset   = 0x00000200, 
        Details = 0x00000400, 
        User1   = 0x00001000, 
        User2   = 0x00002000, 
        User3   = 0x00004000, 
        NoDefault = 0x00008000 
    };

ButtonPopupMode

enum KoDialog::ButtonPopupMode

Enumerator
InstantPopup
DelayedPopup

Definition at line 144 of file KoDialog.h.

                         {
        InstantPopup = 0,
        DelayedPopup = 1
    };

CaptionFlag

enum KoDialog::CaptionFlag

Used to specify how to construct a window caption

Enumerator
NoCaptionFlags
AppNameCaption
ModifiedCaption
HIGCompliantCaption

Definition at line 398 of file KoDialog.h.

                     {
        NoCaptionFlags = 0,
        AppNameCaption = 1,
        ModifiedCaption = 2,
        HIGCompliantCaption = AppNameCaption
    };

Constructor & Destructor Documentation

KoDialog() [1/2]

KoDialog::KoDialog ( QWidget * parent = 0, Qt::WindowFlags f = Qt::WindowFlags() )

explicit

Creates a dialog.

Parameters

parent	The parent of the dialog.
flags	The widget flags passed to the QDialog constructor

Definition at line 176 of file KoDialog.cpp.

    : QDialog(parent ? parent : qApp->activeWindow(), flags)
    , d_ptr(new KoDialogPrivate)
{
    d_ptr->init(this);
}

References d_ptr, and KoDialogPrivate::init().

~KoDialog()

KoDialog::~KoDialog ( )

override

Destroys the dialog.

Definition at line 190 of file KoDialog.cpp.

{
    delete d_ptr;
}

References d_ptr.

KoDialog() [2/2]

KoDialog::KoDialog ( KoDialogPrivate & dd, QWidget * parent, Qt::WindowFlags f = Qt::WindowFlags() )

private

Definition at line 183 of file KoDialog.cpp.

    : QDialog(parent ? parent : qApp->activeWindow(), flags)
    , d_ptr(&dd)
{
    d_ptr->init(this);
}

References d_ptr, and KoDialogPrivate::init().

Member Function Documentation

aboutToShowDetails

void KoDialog::aboutToShowDetails ( )

signal

The detailsWidget is about to get shown. This is your last chance to call setDetailsWidget if you haven't done so yet.

applyClicked

void KoDialog::applyClicked ( )

signal

The Apply button was pressed. This signal is only emitted if slotButtonClicked() is not replaced

button()

QPushButton * KoDialog::button

(

ButtonCode

id

)

const

Returns the button that corresponds to the id.

Normally you should not use this function. Never delete the object returned by this function. See also enableButton(), showButton(), setButtonGuiItem().

Parameters

id	Identifier of the button.

Returns

The button or 0 if the button does not exist.

Definition at line 591 of file KoDialog.cpp.

{
    Q_D(const KoDialog);
    return d->mButtonList.value(id, 0);
}

buttonClicked

void KoDialog::buttonClicked ( KoDialog::ButtonCode button )

signal

A button has been pressed. This signal is only emitted if slotButtonClicked() is not replaced

Parameters

button

is the code of the pressed button.

buttonIcon()

QIcon KoDialog::buttonIcon

(

ButtonCode

id

)

const

Returns the icon of any button.

Definition at line 681 of file KoDialog.cpp.

{
    QPushButton *button = this->button(id);
    if (button) {
        return button->icon();
    } else {
        return QIcon();
    }
}

References button().

buttonText()

QString KoDialog::buttonText

(

ButtonCode

id

)

const

Returns the text of any button.

Definition at line 663 of file KoDialog.cpp.

{
    QPushButton *button = this->button(id);
    if (button) {
        return button->text();
    } else {
        return QString();
    }
}

References button().

buttonToolTip()

QString KoDialog::buttonToolTip

(

ButtonCode

id

)

const

Returns the tooltip of any button.

Definition at line 703 of file KoDialog.cpp.

{
    QPushButton *button = this->button(id);
    if (button) {
        return button->toolTip();
    } else {
        return QString();
    }
}

References button().

buttonWhatsThis()

QString KoDialog::buttonWhatsThis

(

ButtonCode

id

)

const

Returns the "What's this?" text of any button.

Definition at line 725 of file KoDialog.cpp.

{
    QPushButton *button = this->button(id);
    if (button) {
        return button->whatsThis();
    } else {
        return QString();
    }
}

References button().

cancelClicked

void KoDialog::cancelClicked ( )

signal

The Cancel button was pressed. This signal is only emitted if slotButtonClicked() is not replaced

closeClicked

void KoDialog::closeClicked ( )

signal

The Close button was pressed. This signal is only emitted if slotButtonClicked() is not replaced

closeEvent()

void KoDialog::closeEvent ( QCloseEvent * e )

overrideprotected

Detects when a dialog is being closed from the window manager controls. If the Cancel or Close button is present then the button is activated. Otherwise standard QDialog behavior will take place.

Definition at line 943 of file KoDialog.cpp.

{
    Q_D(KoDialog);
    QPushButton *button = this->button(d->mEscapeButton);
    if (button && !isHidden()) {
        button->animateClick();
 
        if (testAttribute(Qt::WA_DeleteOnClose)) {
            // Don't let QWidget::close do a deferred delete just yet, wait for the click first
            d->mDeferredDelete = true;
            setAttribute(Qt::WA_DeleteOnClose, false);
        }
    } else {
        QDialog::closeEvent(event);
    }
}

References button().

defaultButton()

KoDialog::ButtonCode KoDialog::defaultButton

(

)

const

Returns the button code of the default button, or NoDefault if there is no default button.

Definition at line 340 of file KoDialog.cpp.

{
    Q_D(const KoDialog);
    QHashIterator<int, QPushButton *> it(d->mButtonList);
    while (it.hasNext()) {
        it.next();
        if (it.value()->isDefault()) {
            return (ButtonCode)it.key();
        }
    }
 
    return d->mDefaultButton;
}

defaultClicked

void KoDialog::defaultClicked ( )

signal

The Default button was pressed. This signal is only emitted if slotButtonClicked() is not replaced

delayedDestruct

void KoDialog::delayedDestruct ( )

slot

Destruct the dialog delayed.

You can call this function from slots like closeClicked() and hidden(). You should not use the dialog any more after calling this function.

Deprecated

use hide()+deleteLater()

Definition at line 811 of file KoDialog.cpp.

{
    if (isVisible()) {
        hide();
    }
 
    deleteLater();
}

enableButton

void KoDialog::enableButton ( ButtonCode id, bool state )

slot

Enable or disable (gray out) a general action button.

Parameters

id	Button identifier.
state	true enables the button(s).

Definition at line 597 of file KoDialog.cpp.

{
    QPushButton *button = this->button(id);
    if (button) {
        button->setEnabled(state);
    }
}

References button().

enableButtonApply

void KoDialog::enableButtonApply ( bool state )

slot

Enable or disable (gray out) the Apply button.

Parameters

state

true enables the button.

Definition at line 620 of file KoDialog.cpp.

{
    enableButton(Apply, state);
}

References Apply, and enableButton().

enableButtonCancel

void KoDialog::enableButtonCancel ( bool state )

slot

Enable or disable (gray out) the Cancel button.

Parameters

state

true enables the button.

Definition at line 625 of file KoDialog.cpp.

{
    enableButton(Cancel, state);
}

References Cancel, and enableButton().

enableButtonOk

void KoDialog::enableButtonOk ( bool state )

slot

Enable or disable (gray out) the OK button.

Parameters

state

true enables the button.

Definition at line 615 of file KoDialog.cpp.

{
    enableButton(Ok, state);
}

References enableButton(), and Ok.

enableLinkedHelp

void KoDialog::enableLinkedHelp ( bool state )

slot

Display or hide the help link area on the top of the dialog.

Parameters

state

true will display the area.

See also

helpLinkText()

setHelpLinkText()

setHelp()

Definition at line 885 of file KoDialog.cpp.

{
    Q_D(KoDialog);
    if ((d->mUrlHelp != 0) == state) {
        return;
    }
    if (state) {
        if (d->mUrlHelp) {
            return;
        }
 
        d->mUrlHelp = new KUrlLabel(this);
        d->mUrlHelp->setText(helpLinkText());
        d->mUrlHelp->setFloatEnabled(true);
        d->mUrlHelp->setUnderline(true);
        d->mUrlHelp->setMinimumHeight(fontMetrics().height() + marginHint());
        connect(d->mUrlHelp, SIGNAL(leftClickedUrl()), SLOT(helpLinkClicked()));
 
        d->mUrlHelp->show();
    } else {
        delete d->mUrlHelp;
        d->mUrlHelp = 0;
    }
 
    d->setupLayout();
}

References connect(), helpLinkText(), and marginHint().

finished

void KoDialog::finished ( )

signal

The dialog has finished.

A dialog emits finished after a user clicks a button that ends the dialog.

This signal is also emitted when you call hide()

If you have stored a pointer to the dialog do not try to delete the pointer in the slot that is connected to this signal.

You should use deleteLater() instead.

groupSpacingHint()

int KoDialog::groupSpacingHint ( )

static

Returns the number of pixels that should be used to visually separate groups of related options in a dialog according to the KDE standard.

Since

4.2

Definition at line 465 of file KoDialog.cpp.

{
    return QApplication::fontMetrics().lineSpacing();
}

helpClicked

void KoDialog::helpClicked ( )

signal

The Help button was pressed. This signal is only emitted if slotButtonClicked() is not replaced

helpLinkText()

QString KoDialog::helpLinkText

(

)

const

Returns the help link text.

If no text has been defined, "Get help..." (internationalized) is returned.

Returns

The help link text.

See also

enableLinkedHelp()

setHelpLinkText()

setHelp()

Definition at line 928 of file KoDialog.cpp.

{
    Q_D(const KoDialog);
    return (d->mHelpLinkText.isEmpty() ? i18n("Get help...") : d->mHelpLinkText);
}

hidden

void KoDialog::hidden ( )

signal

The dialog is about to be hidden.

A dialog is hidden after a user clicks a button that ends the dialog or when the user switches to another desktop or minimizes the dialog.

hideEvent()

void KoDialog::hideEvent ( QHideEvent * event )

overrideprotected

Emits the hidden signal. You can connect to that signal to detect when a dialog has been closed.

Definition at line 934 of file KoDialog.cpp.

{
    Q_EMIT hidden();
 
    if (!event->spontaneous()) {
        Q_EMIT finished();
    }
}

References finished(), and hidden().

incrementInitialSize()

void KoDialog::incrementInitialSize

(

const QSize &

size

)

Convenience method. Add a size to the default minimum size of a dialog.

This method should only be called right before show() or exec().

Parameters

size	Size added to minimum size.

Definition at line 585 of file KoDialog.cpp.

{
    d_func()->mIncSize = size;
    adjustSize();
}

isButtonEnabled()

bool KoDialog::isButtonEnabled

(

ButtonCode

id

)

const

Returns whether any button is enabled.

Definition at line 605 of file KoDialog.cpp.

{
    QPushButton *button = this->button(id);
    if (button) {
        return button->isEnabled();
    }
 
    return false;
}

References button().

isDetailsWidgetVisible

bool KoDialog::isDetailsWidgetVisible ( ) const

slot

Returns the status of the Details button.

Definition at line 764 of file KoDialog.cpp.

{
    return d_func()->mDetailsVisible;
}

keyPressEvent()

void KoDialog::keyPressEvent ( QKeyEvent * event )

overrideprotected

Definition at line 404 of file KoDialog.cpp.

{
    Q_D(KoDialog);
    if (event->modifiers() == 0) {
        if (event->key() == Qt::Key_F1) {
            QPushButton *button = this->button(Help);
 
            if (button) {
                button->animateClick();
                event->accept();
                return;
            }
        }
 
        if (event->key() == Qt::Key_Escape) {
            QPushButton *button = this->button(d->mEscapeButton);
 
            if (button) {
                button->animateClick();
                event->accept();
                return;
            }
 
        }
    } else if (event->key() == Qt::Key_F1 && event->modifiers() == Qt::ShiftModifier) {
        QWhatsThis::enterWhatsThisMode();
        event->accept();
        return;
    } else if (event->modifiers() == Qt::ControlModifier &&
               (event->key() == Qt::Key_Return || event->key() == Qt::Key_Enter)) {
        // accept the dialog when Ctrl-Return is pressed
        QPushButton *button = this->button(Ok);
 
        if (button) {
            button->animateClick();
            event->accept();
            return;
        }
    }
 
    QDialog::keyPressEvent(event);
}

References button(), Help, and Ok.

layoutHintChanged

void KoDialog::layoutHintChanged ( )

signal

Emitted when the margin size and/or spacing size have changed.

Use marginHint() and spacingHint() in your slot to get the new values.

Deprecated

This signal is not emitted. Listen to QEvent::StyleChange events instead.

mainWidget()

QWidget * KoDialog::mainWidget

(

)

Returns

The current main widget. Will create a QWidget as the mainWidget if none was set before. This way you can write

ui.setupUi(mainWidget());

when using designer.

Definition at line 368 of file KoDialog.cpp.

{
    Q_D(KoDialog);
    if (!d->mMainWidget) {
        setMainWidget(new QWidget(this));
    }
    return d->mMainWidget;
}

References setMainWidget().

makeStandardCaption()

QString KoDialog::makeStandardCaption ( const QString & userCaption, QWidget * window = 0, CaptionFlags flags = HIGCompliantCaption )

static

Builds a caption that contains the application name along with the userCaption using a standard layout.

To make a compliant caption for your window, simply do: setWindowTitle(KoDialog::makeStandardCaption(yourCaption));

To ensure that the caption is appropriate to the desktop in which the application is running, pass in a pointer to the window the caption will be applied to.

If using a KoDialog or KisKMainWindow subclass, call setCaption instead and an appropriate standard caption will be created for you

Parameters

userCaption	The caption string you want to display in the window caption area. Do not include the application name!
window	a pointer to the window this application will apply to
flags

Returns

the created caption

Definition at line 470 of file KoDialog.cpp.

{
    Q_UNUSED(window);
    QString caption = qApp->applicationDisplayName();
    QString captionString = userCaption.isEmpty() ? caption : userCaption;
 
    // If the document is modified, add '[modified]'.
    if (flags & ModifiedCaption) {
        captionString += QString::fromUtf8(" [") + i18n("modified") + QString::fromUtf8("]");
    }
 
    if (!userCaption.isEmpty()) {
        // Add the application name if:
        // User asked for it, it's not a duplication  and the app name (caption()) is not empty
        if (flags & AppNameCaption &&
                !caption.isEmpty() &&
                !userCaption.endsWith(caption)) {
            // TODO: check to see if this is a transient/secondary window before trying to add the app name
            //       on platforms that need this
            captionString += i18nc("Document/application separator in titlebar", " – ") + caption;
        }
    }
 
    return captionString;
}

References AppNameCaption, and ModifiedCaption.

marginHint()

int KoDialog::marginHint ( )

static

Returns the number of pixels that should be used between a dialog edge and the outermost widget(s) according to the KDE standard.

Deprecated

Use the style's pixelMetric() function to query individual margins. Different platforms may use different values for the four margins.

Definition at line 455 of file KoDialog.cpp.

{
    return QApplication::style()->pixelMetric(QStyle::PM_LayoutLeftMargin);
}

minimumSizeHint()

QSize KoDialog::minimumSizeHint ( ) const

override

Reimplemented from QDialog.

Definition at line 391 of file KoDialog.cpp.

{
    Q_D(const KoDialog);
 
    if (d->dirty) {
        const_cast<KoDialogPrivate *>(d)->queuedLayoutUpdate();
    }
    return QDialog::minimumSizeHint() + d->mIncSize;
}

noClicked

void KoDialog::noClicked ( )

signal

The No button was pressed. This signal is only emitted if slotButtonClicked() is not replaced

okClicked

void KoDialog::okClicked ( )

signal

The OK button was pressed. This signal is only emitted if slotButtonClicked() is not replaced

resetClicked

void KoDialog::resetClicked ( )

signal

The Reset button was pressed. This signal is only emitted if slotButtonClicked() is not replaced

resizeLayout() [1/2]

void KoDialog::resizeLayout ( QLayout * lay, int margin, int spacing )

static

Resize every layout associated with lay and its children.

Parameters

lay	layout to be resized
margin	The new layout margin
spacing	The new layout spacing

Deprecated

Use QLayout functions where necessary. Setting margin and spacing values recursively for all children prevents QLayout from creating platform native layouts.

Definition at line 539 of file KoDialog.cpp.

{
    QLayoutItem *child;
    int pos = 0;
 
    while ((child = layout->itemAt(pos))) {
        if (child->layout()) {
            resizeLayout(child->layout(), margin, spacing);
        }
 
        ++pos;
    }
 
    if (layout->layout()) {
        layout->layout()->setContentsMargins(margin, margin, margin, margin);
        layout->layout()->setSpacing(spacing);
    }
}

References resizeLayout().

resizeLayout() [2/2]

void KoDialog::resizeLayout ( QWidget * widget, int margin, int spacing )

static

Resize every layout manager used in widget and its nested children.

Parameters

widget	The widget used.
margin	The new layout margin.
spacing	The new layout spacing.

Deprecated

Use QLayout functions where necessary. Setting margin and spacing values recursively for all children prevents QLayout from creating platform native layouts.

Definition at line 523 of file KoDialog.cpp.

{
    if (widget->layout()) {
        resizeLayout(widget->layout(), margin, spacing);
    }
 
    if (widget->children().count() > 0) {
        const QList<QObject *> list = widget->children();
        foreach (QObject *object, list) {
            if (object->isWidgetType()) {
                resizeLayout((QWidget *)object, margin, spacing);
            }
        }
    }
}

References resizeLayout().

setButtonFocus()

void KoDialog::setButtonFocus

(

ButtonCode

id

)

Sets the focus to the button of the passed id.

Definition at line 735 of file KoDialog.cpp.

{
    QPushButton *button = this->button(id);
    if (button) {
        button->setFocus();
    }
}

References button().

setButtonGuiItem()

void KoDialog::setButtonGuiItem	(	ButtonCode	id,
		const KGuiItem &	item )

Sets the KGuiItem directly for the button instead of using 3 methods to set the text, tooltip and whatsthis strings. This also allows to set an icon for the button which is otherwise not possible for the extra buttons beside Ok, Cancel and Apply.

Parameters

id	The button identifier.
item	The KGuiItem for the button.

Definition at line 638 of file KoDialog.cpp.

{
    QPushButton *button = this->button(id);
    if (!button) {
        return;
    }
 
    KGuiItem::assign(button, item);
}

References button().

setButtonIcon()

void KoDialog::setButtonIcon	(	ButtonCode	id,
		const QIcon &	icon )

Sets the icon of any button.

Parameters

id	The button identifier.
icon	Button icon.

Definition at line 673 of file KoDialog.cpp.

{
    QPushButton *button = this->button(id);
    if (button) {
        button->setIcon(icon);
    }
}

References button().

setButtons()

void KoDialog::setButtons

(

ButtonCodes

buttonMask

)

Creates (or recreates) the button box and all the buttons in it.

Note that some combinations are not possible. That means, you can't have the following pairs of buttons in a dialog:

• Default and Details
• Cancel and Close
• Ok and Try

This will reset all default KGuiItem of all button.

Parameters

buttonMask

Specifies what buttons will be made.

Deprecated

Since 5.0 use QDialogButtonBox

Definition at line 195 of file KoDialog.cpp.

{
    Q_D(KoDialog);
    if (d->mButtonBox) {
        d->mButtonList.clear();
 
        delete d->mButtonBox;
        d->mButtonBox = 0;
    }
 
    if (buttonMask & Cancel) {
        buttonMask &= ~Close;
    }
 
    if (buttonMask & Apply) {
        buttonMask &= ~Try;
    }
 
    if (buttonMask & Details) {
        buttonMask &= ~Default;
    }
 
    if (buttonMask == None) {
        d->setupLayout();
        return; // When we want no button box
    }
 
    d->mEscapeButton = (buttonMask & Cancel) ? Cancel : Close;
    d->mButtonBox = new QDialogButtonBox(this);
 
    if (buttonMask & Help) {
        d->appendButton(Help, KStandardGuiItem::help());
    }
    if (buttonMask & Default) {
        d->appendButton(Default, KStandardGuiItem::defaults());
    }
    if (buttonMask & Reset) {
        d->appendButton(Reset, KStandardGuiItem::reset());
    }
    if (buttonMask & User3) {
        d->appendButton(User3, KGuiItem());
    }
    if (buttonMask & User2) {
        d->appendButton(User2, KGuiItem());
    }
    if (buttonMask & User1) {
        d->appendButton(User1, KGuiItem());
    }
    if (buttonMask & Ok) {
        d->appendButton(Ok, KStandardGuiItem::ok());
    }
    if (buttonMask & Apply) {
        d->appendButton(Apply, KStandardGuiItem::apply());
    }
    if (buttonMask & Try) {
        d->appendButton(Try, KGuiItem(i18n("&Try")));
    }
    if (buttonMask & Cancel) {
        d->appendButton(Cancel, KStandardGuiItem::cancel());
    }
    if (buttonMask & Close) {
        d->appendButton(Close, KStandardGuiItem::close());
    }
    if (buttonMask & Yes) {
#if (QT_VERSION < QT_VERSION_CHECK(6, 0, 0))
        d->appendButton(Yes, KStandardGuiItem::yes());
#else
        d->appendButton(Yes, KStandardGuiItem::apply());
#endif
    }
    if (buttonMask & No) {
#if (QT_VERSION < QT_VERSION_CHECK(6, 0, 0))
        d->appendButton(No, KStandardGuiItem::no());
#else
        d->appendButton(No, KStandardGuiItem::cancel());
#endif
 
    }
    if (buttonMask & Details) {
        d->appendButton(Details, KGuiItem(QString(), "help-about"));
        setDetailsWidgetVisible(false);
    }
 
    d->setupLayout();
}

References Apply, Cancel, Close, Default, Details, Help, No, None, Ok, Reset, setDetailsWidgetVisible(), Try, User1, User2, User3, and Yes.

setButtonsOrientation()

void KoDialog::setButtonsOrientation

(

Qt::Orientation

orientation

)

Sets the orientation of the button box.

It can be Vertical or Horizontal. If Horizontal (default), the button box is positioned at the bottom of the dialog. If Vertical it will be placed at the right edge of the dialog.

Parameters

orientation

The button box orientation.

Definition at line 281 of file KoDialog.cpp.

{
    Q_D(KoDialog);
    if (d->mButtonOrientation != orientation) {
        d->mButtonOrientation = orientation;
 
        if (d->mActionSeparator) {
            d->mActionSeparator->setOrientation(d->mButtonOrientation);
        }
 
        if (d->mButtonOrientation == Qt::Vertical) {
            enableLinkedHelp(false);    // 2000-06-18 Espen: No support for this yet.
        }
    }
}

References enableLinkedHelp().

setButtonText()

void KoDialog::setButtonText	(	ButtonCode	id,
		const QString &	text )

Sets the text of any button.

Parameters

id	The button identifier.
text	Button text.

Definition at line 648 of file KoDialog.cpp.

{
    Q_D(KoDialog);
    if (!d->mSettingDetails && (id == Details)) {
        d->mDetailsButtonText = text;
        setDetailsWidgetVisible(d->mDetailsVisible);
        return;
    }
 
    QPushButton *button = this->button(id);
    if (button) {
        button->setText(text);
    }
}

References button(), Details, and setDetailsWidgetVisible().

setButtonToolTip()

void KoDialog::setButtonToolTip	(	ButtonCode	id,
		const QString &	text )

Sets the tooltip text of any button.

Parameters

id	The button identifier.
text	Button text.

Definition at line 691 of file KoDialog.cpp.

{
    QPushButton *button = this->button(id);
    if (button) {
        if (text.isEmpty()) {
            button->setToolTip(QString());
        } else {
            button->setToolTip(text);
        }
    }
}

References button().

setButtonWhatsThis()

void KoDialog::setButtonWhatsThis	(	ButtonCode	id,
		const QString &	text )

Sets the "What's this?" text of any button.

Parameters

id	The button identifier.
text	Button text.

Definition at line 713 of file KoDialog.cpp.

{
    QPushButton *button = this->button(id);
    if (button) {
        if (text.isEmpty()) {
            button->setWhatsThis(QString());
        } else {
            button->setWhatsThis(text);
        }
    }
}

References button().

setCaption [1/2]

void KoDialog::setCaption ( const QString & caption )

virtualslot

Make a KDE compliant caption.

Parameters

caption

Your caption. Do not include the application name in this string. It will be added automatically according to the KDE standard.

Deprecated

Since 5.0 use QWidget::setWindowTitle

Definition at line 498 of file KoDialog.cpp.

{
    const QString caption = makeStandardCaption(_caption, this);
    setPlainCaption(caption);
}

References makeStandardCaption(), and setPlainCaption().

setCaption [2/2]

void KoDialog::setCaption ( const QString & caption, bool modified )

virtualslot

Makes a KDE compliant caption.

Parameters

caption	Your caption. Do not include the application name in this string. It will be added automatically according to the KDE standard.
modified	Specify whether the document is modified. This displays an additional sign in the title bar, usually "**".

Deprecated

Since 5.0 use QWidget::setWindowTitle and QWidget::setWindowModified.

Definition at line 504 of file KoDialog.cpp.

{
    CaptionFlags flags = HIGCompliantCaption;
 
    // ### Qt5 TODO: port to [*], see QWidget::setWindowFilePath
    if (modified) {
        flags |= ModifiedCaption;
    }
 
    setPlainCaption(makeStandardCaption(caption, this, flags));
}

References HIGCompliantCaption, makeStandardCaption(), ModifiedCaption, and setPlainCaption().

setDefaultButton()

void KoDialog::setDefaultButton

(

ButtonCode

id

)

Sets the button that will be activated when the Enter key is pressed.

By default, this is the Ok button if it is present

Parameters

id	The button code.

Definition at line 302 of file KoDialog.cpp.

{
    Q_D(KoDialog);
 
    if (newDefaultButton == None) {
        newDefaultButton = NoDefault;    // #148969
    }
 
    const KoDialog::ButtonCode oldDefault = defaultButton();
 
    bool oldDefaultHadFocus = false;
 
    if (oldDefault != NoDefault) {
        QPushButton *old = button(oldDefault);
        if (old) {
            oldDefaultHadFocus = (focusWidget() == old);
            old->setDefault(false);
        }
    }
 
    if (newDefaultButton != NoDefault) {
        QPushButton *b = button(newDefaultButton);
        if (b) {
            b->setDefault(true);
            if (focusWidget() == 0 || oldDefaultHadFocus) {
                // No widget had focus yet, or the old default button had
                // -> ok to give focus to the new default button, so that it's
                // really default (Enter triggers it).
                // But we don't do this if the kdialog user gave focus to a
                // specific widget in the dialog.
                b->setFocus();
            }
        }
    }
    d->mDefaultButton = newDefaultButton;
    Q_ASSERT(defaultButton() == newDefaultButton);
}

References button(), defaultButton(), NoDefault, and None.

setDetailsWidget

void KoDialog::setDetailsWidget ( QWidget * detailsWidget )

slot

Sets the widget that gets shown when "Details" is enabled.

The dialog takes over ownership of the widget. Any previously set widget gets deleted.

Definition at line 743 of file KoDialog.cpp.

{
    Q_D(KoDialog);
    if (d->mDetailsWidget == detailsWidget) {
        return;
    }
    delete d->mDetailsWidget;
    d->mDetailsWidget = detailsWidget;
 
    if (d->mDetailsWidget->parentWidget() != this) {
        d->mDetailsWidget->setParent(this);
    }
 
    d->mDetailsWidget->hide();
    d->setupLayout();
 
    if (!d->mSettingDetails) {
        setDetailsWidgetVisible(d->mDetailsVisible);
    }
}

References setDetailsWidgetVisible().

setDetailsWidgetVisible

void KoDialog::setDetailsWidgetVisible ( bool visible )

slot

Sets the status of the Details button.

Definition at line 769 of file KoDialog.cpp.

{
    Q_D(KoDialog);
    if (d->mDetailsButtonText.isEmpty()) {
        d->mDetailsButtonText = i18n("&Details");
    }
 
    d->mSettingDetails = true;
    d->mDetailsVisible = visible;
    if (d->mDetailsVisible) {
        Q_EMIT aboutToShowDetails();
        setButtonText(Details, d->mDetailsButtonText + " <<");
        if (d->mDetailsWidget) {
            if (layout()) {
                layout()->setEnabled(false);
            }
 
            d->mDetailsWidget->show();
 
            adjustSize();
 
            if (layout()) {
                layout()->activate();
                layout()->setEnabled(true);
            }
        }
    } else {
        setButtonText(Details, d->mDetailsButtonText + " >>");
        if (d->mDetailsWidget) {
            d->mDetailsWidget->hide();
        }
 
        if (layout()) {
            layout()->activate();
            adjustSize();
        }
 
    }
 
    d->mSettingDetails = false;
}

References aboutToShowDetails(), Details, and setButtonText().

setEscapeButton()

void KoDialog::setEscapeButton

(

ButtonCode

id

)

Sets the button that will be activated when the Escape key is pressed.

By default, the Escape key is mapped to either the Cancel or the Close button if one of these buttons are defined. The user expects that Escape will cancel an operation so use this function with caution.

Parameters

id	The button code.

Definition at line 297 of file KoDialog.cpp.

{
    d_func()->mEscapeButton = id;
}

setHelp

void KoDialog::setHelp ( const QString & anchor, const QString & appname = QString() )

slot

Sets the help path and topic.

Parameters

anchor	Defined anchor in your docbook sources
appname	Defines the appname the help belongs to If empty it's the current one

Note

The help button works differently for the class KCMultiDialog, so it does not make sense to call this function for Dialogs of that type. See KCMultiDialog::slotHelp() for more information.

Definition at line 912 of file KoDialog.cpp.

{
    Q_D(KoDialog);
    d->mAnchor  = anchor;
    d->mHelpApp = appname;
}

setHelpLinkText

void KoDialog::setHelpLinkText ( const QString & text )

slot

Sets the text that is shown as the linked text.

If text is empty, the text "Get help..." (internationalized) is used instead.

Parameters

text	The link text.

See also

helpLinkText()

enableLinkedHelp()

setHelp()

Definition at line 919 of file KoDialog.cpp.

{
    Q_D(KoDialog);
    d->mHelpLinkText = text;
    if (d->mUrlHelp) {
        d->mUrlHelp->setText(helpLinkText());
    }
}

References helpLinkText().

setInitialSize()

void KoDialog::setInitialSize

(

const QSize &

size

)

Convenience method. Sets the initial dialog size.

This method should only be called right before show() or exec(). The initial size will be ignored if smaller than the dialog's minimum size.

Parameters

size	Startup size.

Definition at line 579 of file KoDialog.cpp.

{
    d_func()->mMinSize = size;
    adjustSize();
}

setMainWidget()

void KoDialog::setMainWidget

(

QWidget *

widget

)

Sets the main widget of the dialog.

Definition at line 354 of file KoDialog.cpp.

{
    Q_D(KoDialog);
    if (d->mMainWidget == widget) {
        return;
    }
    d->mMainWidget = widget;
    if (d->mMainWidget && d->mMainWidget->layout()) {
        // Avoid double-margin problem
        d->mMainWidget->layout()->setContentsMargins(0, 0, 0, 0);
    }
    d->setupLayout();
}

setPlainCaption

void KoDialog::setPlainCaption ( const QString & caption )

virtualslot

Make a plain caption without any modifications.

Parameters

caption

Your caption. This is the string that will be displayed in the window title.

Definition at line 516 of file KoDialog.cpp.

{
    if (QWidget *win = window()) {
        win->setWindowTitle(caption);
    }
}

showButton()

void KoDialog::showButton	(	ButtonCode	id,
		bool	state )

Hide or display a general action button.

Only buttons that have been created in the constructor can be displayed. This method will not create a new button.

Parameters

id	Button identifier.
state	true display the button(s).

Definition at line 630 of file KoDialog.cpp.

{
    QPushButton *button = this->button(id);
    if (button) {
        state ? button->show() : button->hide();
    }
}

References button().

showButtonSeparator()

void KoDialog::showButtonSeparator

(

bool

state

)

Hide or display the a separator line drawn between the action buttons an the main widget.

Definition at line 558 of file KoDialog.cpp.

{
    Q_D(KoDialog);
    if ((d->mActionSeparator != 0) == state) {
        return;
    }
    if (state) {
        if (d->mActionSeparator) {
            return;
        }
 
        d->mActionSeparator = new KSeparator(this);
        d->mActionSeparator->setOrientation(d->mButtonOrientation);
    } else {
        delete d->mActionSeparator;
        d->mActionSeparator = 0;
    }
 
    d->setupLayout();
}

showEvent()

void KoDialog::showEvent ( QShowEvent * e )

overrideprotected

Definition at line 447 of file KoDialog.cpp.

{
    QDialog::showEvent(e);
    QTimer::singleShot(5, Qt::CoarseTimer, [&]() {
        adjustPosition(parentWidget());
    });
}

sizeHint()

QSize KoDialog::sizeHint ( ) const

override

Reimplemented from QDialog.

Definition at line 377 of file KoDialog.cpp.

{
    Q_D(const KoDialog);
 
    if (!d->mMinSize.isEmpty()) {
        return d->mMinSize.expandedTo(minimumSizeHint()) + d->mIncSize;
    } else {
        if (d->dirty) {
            const_cast<KoDialogPrivate *>(d)->queuedLayoutUpdate();
        }
        return QDialog::sizeHint() + d->mIncSize;
    }
}

References minimumSizeHint().

slotButtonClicked

void KoDialog::slotButtonClicked ( int button )

protectedvirtualslot

Activated when the button button is clicked

Sample that shows how to catch and handle button clicks within an own dialog;

class MyDialog : public KoDialog {
    protected Q_SLOTS:
        virtual void slotButtonClicked(int button) {
            if (button == KoDialog::Ok)
                accept();
            else
                KoDialog::slotButtonClicked(button);
        }
}

Parameters

button

is the type KoDialog::ButtonCode

Deprecated

since 5.0 use QDialogButtonBox and connect to the clicked signal

Definition at line 820 of file KoDialog.cpp.

{
    Q_D(KoDialog);
    Q_EMIT buttonClicked(static_cast<KoDialog::ButtonCode>(button));
 
    switch (button) {
    case Ok:
        Q_EMIT okClicked();
        accept();
        break;
    case Apply:
        Q_EMIT applyClicked();
        break;
    case Try:
        Q_EMIT tryClicked();
        break;
    case User3:
        Q_EMIT user3Clicked();
        break;
    case User2:
        Q_EMIT user2Clicked();
        break;
    case User1:
        Q_EMIT user1Clicked();
        break;
    case Yes:
        Q_EMIT yesClicked();
        done(Yes);
        break;
    case No:
        Q_EMIT noClicked();
        done(No);
        break;
    case Cancel:
        Q_EMIT cancelClicked();
        reject();
        break;
    case Close:
        Q_EMIT closeClicked();
        done(Close); // KDE5: call reject() instead; more QDialog-like.
        break;
    case Help:
        Q_EMIT helpClicked();
        if (!d->mAnchor.isEmpty() || !d->mHelpApp.isEmpty()) {
            KHelpClient::invokeHelp(d->mAnchor, d->mHelpApp);
        }
        break;
    case Default:
        Q_EMIT defaultClicked();
        break;
    case Reset:
        Q_EMIT resetClicked();
        break;
    case Details:
        setDetailsWidgetVisible(!d->mDetailsVisible);
        break;
    }
 
    // If we're here from the closeEvent, and auto-delete is on, well, auto-delete now.
    if (d->mDeferredDelete) {
        d->mDeferredDelete = false;
        delayedDestruct();
    }
}

References Apply, applyClicked(), button(), buttonClicked(), Cancel, cancelClicked(), Close, closeClicked(), Default, defaultClicked(), delayedDestruct(), Details, Help, helpClicked(), KHelpClient::invokeHelp(), No, noClicked(), Ok, okClicked(), Reset, resetClicked(), setDetailsWidgetVisible(), Try, tryClicked(), User1, user1Clicked(), User2, user2Clicked(), User3, user3Clicked(), Yes, and yesClicked().

spacingHint()

int KoDialog::spacingHint ( )

static

Returns the number of pixels that should be used between widgets inside a dialog according to the KDE standard.

Deprecated

Use the style's layoutSpacing() function to query individual spacings. Different platforms may use different values depending on widget types and pairs.

Definition at line 460 of file KoDialog.cpp.

{
    return QApplication::style()->pixelMetric(QStyle::PM_LayoutHorizontalSpacing);
}

tryClicked

void KoDialog::tryClicked ( )

signal

The Try button was pressed. This signal is only emitted if slotButtonClicked() is not replaced

user1Clicked

void KoDialog::user1Clicked ( )

signal

The User1 button was pressed. This signal is only emitted if slotButtonClicked() is not replaced

user2Clicked

void KoDialog::user2Clicked ( )

signal

The User2 button was pressed. This signal is only emitted if slotButtonClicked() is not replaced

user3Clicked

void KoDialog::user3Clicked ( )

signal

The User3 button was pressed. This signal is only emitted if slotButtonClicked() is not replaced

yesClicked

void KoDialog::yesClicked ( )

signal

The Yes button was pressed. This signal is only emitted if slotButtonClicked() is not replaced

Member Data Documentation

d_ptr

KoDialogPrivate* const KoDialog::d_ptr

private

Definition at line 787 of file KoDialog.h.

---

The documentation for this class was generated from the following files:

• libs/widgets/KoDialog.h
• libs/widgets/KoDialog.cpp