KoDocumentInfoDlg Class Reference

The dialog that shows information about the document. More...

#include <KoDocumentInfoDlg.h>

Inheritance diagram for KoDocumentInfoDlg:

Classes
class	KoDocumentInfoDlgPrivate

Public Slots
void	accept () override

Signals
void	saveRequested ()

Public Member Functions
void	addPageItem (KoPageWidgetItem *item)
bool	isDocumentSaved ()
	KoDocumentInfoDlg (QWidget *parent, KoDocumentInfo *docInfo)
QList< KPageWidgetItem * >	pages () const
void	setReadOnly (bool ro)
	~KoDocumentInfoDlg () override

Protected Member Functions
void	hideEvent (QHideEvent *event) override

Private Slots
void	slotResetMetaData ()

Private Member Functions
void	initAboutTab ()
void	initAuthorTab ()
void	saveAboutData ()
void	updateEditingTime ()

Private Attributes
KoDocumentInfoDlgPrivate *const	d

Detailed Description

The dialog that shows information about the document.

Author

Simon Hausmann hausm.nosp@m.ann@.nosp@m.kde.o.nosp@m.rg

Martin Pfeiffer hubip.nosp@m.ete@.nosp@m.gmx.n.nosp@m.et

See also

KoDocumentInfo

This dialog is invoked by KoMainWindow and shows the content of the given KoDocumentInfo class. It consists of several pages, one showing general information about the document and another showing information about the author. This dialog implements only things that are stored in the OASIS meta.xml file and therefore available through the KoDocumentInfo class. The widgets shown in the tabs are koDocumentInfoAboutWidget and koDocumentInfoAuthorWidget. This class here is derived from KPageDialog and uses the face type Tabbed.

Definition at line 39 of file KoDocumentInfoDlg.h.

Constructor & Destructor Documentation

KoDocumentInfoDlg()

KoDocumentInfoDlg::KoDocumentInfoDlg	(	QWidget *	parent,
		KoDocumentInfo *	docInfo )

The constructor

Parameters

parent	a pointer to the parent widget
docInfo	a pointer to the shown KoDocumentInfo

Definition at line 67 of file KoDocumentInfoDlg.cpp.

    : KPageDialog(parent)
    , d(new KoDocumentInfoDlgPrivate)
{
    d->info = docInfo;
 
    setWindowTitle(i18n("Document Information"));
    //    setInitialSize(QSize(500, 500));
    setFaceType(KPageDialog::List);
    setStandardButtons(QDialogButtonBox::Ok | QDialogButtonBox::Cancel);
    button(QDialogButtonBox::Ok)->setDefault(true);
    KGuiItem::assign(button(QDialogButtonBox::Ok), KStandardGuiItem::ok());
    KGuiItem::assign(button(QDialogButtonBox::Cancel), KStandardGuiItem::cancel());
 
    d->aboutUi = new Ui::KoDocumentInfoAboutWidget();
    QWidget *infodlg = new QWidget();
    d->aboutUi->setupUi(infodlg);
    QStringList licenseExamples;
    licenseExamples << "CC-BY 4.0" << "CC-BY-SA 4.0" << "CC-BY-SA-NC 4.0" << "CC-0";
    QCompleter *examples = new QCompleter(licenseExamples);
    examples->setCaseSensitivity(Qt::CaseInsensitive);
    examples->setCompletionMode(QCompleter::PopupCompletion);
    d->aboutUi->leLicense->setCompleter(examples);
 
    KPageWidgetItem *page = new KPageWidgetItem(infodlg, i18n("General"));
    page->setHeader(i18n("General"));
 
    // Ugly hack, the mimetype should be a parameter, instead
    KisDocument* doc = dynamic_cast< KisDocument* >(d->info->parent());
    if (doc) {
        page->setIcon(KisIconUtils::loadIcon(KisMimeDatabase::iconNameForMimeType(doc->mimeType())));
    } else {
        // hide all entries not used in pages for KoDocumentInfoPropsPage
        d->aboutUi->filePathInfoLabel->setVisible(false);
        d->aboutUi->filePathLabel->setVisible(false);
        d->aboutUi->filePathSeparatorLine->setVisible(false);
        d->aboutUi->lblTypeDesc->setVisible(false);
        d->aboutUi->lblType->setVisible(false);
    }
    addPage(page);
    d->pages.append(page);
 
    initAboutTab();
 
    d->authorUi = new Ui::KoDocumentInfoAuthorWidget();
    QWidget *authordlg = new QWidget();
    d->authorUi->setupUi(authordlg);
    page = new KPageWidgetItem(authordlg, i18n("Author"));
    page->setHeader(i18n("Last saved by"));
    page->setIcon(koIcon("user-identity"));
    addPage(page);
    d->pages.append(page);
 
    initAuthorTab();
}

References KoDocumentInfoDlg::KoDocumentInfoDlgPrivate::aboutUi, KoDocumentInfoDlg::KoDocumentInfoDlgPrivate::authorUi, button(), d, KisMimeDatabase::iconNameForMimeType(), KoDocumentInfoDlg::KoDocumentInfoDlgPrivate::info, initAboutTab(), initAuthorTab(), koIcon, KisIconUtils::loadIcon(), KisDocument::mimeType, and KoDocumentInfoDlg::KoDocumentInfoDlgPrivate::pages.

~KoDocumentInfoDlg()

KoDocumentInfoDlg::~KoDocumentInfoDlg ( )

override

The destructor

Definition at line 123 of file KoDocumentInfoDlg.cpp.

{
    delete d->authorUi;
    delete d->aboutUi;
    delete d;
}

References KoDocumentInfoDlg::KoDocumentInfoDlgPrivate::aboutUi, KoDocumentInfoDlg::KoDocumentInfoDlgPrivate::authorUi, and d.

Member Function Documentation

accept

void KoDocumentInfoDlg::accept ( )

overrideslot

Definition at line 130 of file KoDocumentInfoDlg.cpp.

{
    // check if any pages veto the close
    Q_FOREACH (KPageWidgetItem* item, d->pages) {
        KoPageWidgetItemAdapter *page = dynamic_cast<KoPageWidgetItemAdapter*>(item);
        if (page) {
            if (page->shouldDialogCloseBeVetoed()) {
                return;
            }
        }
    }
 
    // all fine, go and apply
    saveAboutData();
    Q_FOREACH (KPageWidgetItem* item, d->pages) {
        KoPageWidgetItemAdapter *page = dynamic_cast<KoPageWidgetItemAdapter*>(item);
        if (page) {
            page->apply();
        }
    }
 
    KPageDialog::accept();
}

References KoPageWidgetItemAdapter::apply(), d, KoDocumentInfoDlg::KoDocumentInfoDlgPrivate::pages, saveAboutData(), and KoPageWidgetItemAdapter::shouldDialogCloseBeVetoed().

addPageItem()

void KoDocumentInfoDlg::addPageItem

(

KoPageWidgetItem *

item

)

Definition at line 274 of file KoDocumentInfoDlg.cpp.

{
    KPageWidgetItem * page = new KoPageWidgetItemAdapter(item);
 
    addPage(page);
    d->pages.append(page);
}

References d, and KoDocumentInfoDlg::KoDocumentInfoDlgPrivate::pages.

hideEvent()

void KoDocumentInfoDlg::hideEvent ( QHideEvent * event )

overrideprotected

Definition at line 229 of file KoDocumentInfoDlg.cpp.

{
    Q_UNUSED(event);
}

initAboutTab()

void KoDocumentInfoDlg::initAboutTab ( )

private

Sets up the aboutWidget and fills the widgets with content

Definition at line 159 of file KoDocumentInfoDlg.cpp.

{
    KisDocument* doc = dynamic_cast< KisDocument* >(d->info->parent());
 
    if (doc) {
        d->aboutUi->filePathLabel->setText(doc->localFilePath());
    }
 
    d->aboutUi->leTitle->setText(d->info->aboutInfo("title"));
    d->aboutUi->leSubject->setText(d->info->aboutInfo("subject"));
 
    d->aboutUi->leKeywords->setToolTip(i18n("Use ';' (Example: Office;KDE;Calligra)"));
    if (!d->info->aboutInfo("keyword").isEmpty())
        d->aboutUi->leKeywords->setText(d->info->aboutInfo("keyword"));
 
    if (!d->info->aboutInfo("license").isEmpty()) {
        d->aboutUi->leLicense->setText(d->info->aboutInfo("license"));
    }
    d->aboutUi->meDescription->setPlainText(d->info->aboutInfo("abstract"));
    if (doc && !doc->mimeType().isEmpty()) {
        d->aboutUi->lblType->setText(KisMimeDatabase::descriptionForMimeType(doc->mimeType()));
    }
    if (!d->info->aboutInfo("creation-date").isEmpty()) {
        QDateTime t = QDateTime::fromString(d->info->aboutInfo("creation-date"),
                                            Qt::ISODate);
        QString s = QLocale().toString(t);
        d->aboutUi->lblCreated->setText(s + ", " +
                                        d->info->aboutInfo("initial-creator"));
    }
 
    if (!d->info->aboutInfo("date").isEmpty()) {
        QDateTime t = QDateTime::fromString(d->info->aboutInfo("date"), Qt::ISODate);
        QString s = QLocale().toString(t);
        d->aboutUi->lblModified->setText(s + ", " + d->info->authorInfo("creator"));
    }
 
    d->aboutUi->lblRevision->setText(d->info->aboutInfo("editing-cycles"));
 
    updateEditingTime();
 
    connect(d->aboutUi->pbReset, SIGNAL(clicked()),
            this, SLOT(slotResetMetaData()));
}

References KoDocumentInfo::aboutInfo(), KoDocumentInfoDlg::KoDocumentInfoDlgPrivate::aboutUi, KoDocumentInfo::authorInfo(), connect(), d, KisMimeDatabase::descriptionForMimeType(), KoDocumentInfoDlg::KoDocumentInfoDlgPrivate::info, KisDocument::localFilePath(), KisDocument::mimeType, slotResetMetaData(), and updateEditingTime().

initAuthorTab()

void KoDocumentInfoDlg::initAuthorTab ( )

private

Sets up the authorWidget and fills the widgets with content

Definition at line 203 of file KoDocumentInfoDlg.cpp.

{
    d->authorUi->nickName->setText(d->info->authorInfo("creator"));
    d->authorUi->firstName->setText(d->info->authorInfo("creator-first-name"));
    d->authorUi->lastName->setText(d->info->authorInfo("creator-last-name"));
    d->authorUi->initials->setText(d->info->authorInfo("initial"));
    d->authorUi->title->setText(d->info->authorInfo("author-title"));
    d->authorUi->company->setText(d->info->authorInfo("company"));
    d->authorUi->position->setText(d->info->authorInfo("position"));
    QListWidget *contact = d->authorUi->leContact;
    Q_FOREACH(QString contactMode, d->info->authorContactInfo()) {
        if (!contactMode.isEmpty()) {
            contact->addItem(contactMode);
        }
    }
}

References KoDocumentInfo::authorContactInfo(), KoDocumentInfo::authorInfo(), KoDocumentInfoDlg::KoDocumentInfoDlgPrivate::authorUi, d, and KoDocumentInfoDlg::KoDocumentInfoDlgPrivate::info.

isDocumentSaved()

bool KoDocumentInfoDlg::isDocumentSaved

(

)

Returns true if the document was saved when the dialog was closed

Definition at line 154 of file KoDocumentInfoDlg.cpp.

{
    return d->documentSaved;
}

References d, and KoDocumentInfoDlg::KoDocumentInfoDlgPrivate::documentSaved.

pages()

QList< KPageWidgetItem * > KoDocumentInfoDlg::pages

(

)

const

Definition at line 255 of file KoDocumentInfoDlg.cpp.

{
    return d->pages;
}

References d, and KoDocumentInfoDlg::KoDocumentInfoDlgPrivate::pages.

saveAboutData()

void KoDocumentInfoDlg::saveAboutData ( )

private

Saves the changed data back to the KoDocumentInfo class

Definition at line 220 of file KoDocumentInfoDlg.cpp.

{
    d->info->setAboutInfo("keyword", d->aboutUi->leKeywords->text());
    d->info->setAboutInfo("title", d->aboutUi->leTitle->text());
    d->info->setAboutInfo("subject", d->aboutUi->leSubject->text());
    d->info->setAboutInfo("abstract", d->aboutUi->meDescription->toPlainText());
    d->info->setAboutInfo("license", d->aboutUi->leLicense->text());
}

References KoDocumentInfoDlg::KoDocumentInfoDlgPrivate::aboutUi, d, KoDocumentInfoDlg::KoDocumentInfoDlgPrivate::info, and KoDocumentInfo::setAboutInfo().

saveRequested

void KoDocumentInfoDlg::saveRequested ( )

signal

setReadOnly()

void KoDocumentInfoDlg::setReadOnly

(

bool

ro

)

Sets all fields to read-only mode. Used by the property dialog.

Definition at line 260 of file KoDocumentInfoDlg.cpp.

{
    d->aboutUi->meDescription->setReadOnly(ro);
 
    Q_FOREACH(KPageWidgetItem* page, d->pages) {
        Q_FOREACH(QLineEdit* le, page->widget()->findChildren<QLineEdit *>()) {
            le->setReadOnly(ro);
        }
        Q_FOREACH(QPushButton* le, page->widget()->findChildren<QPushButton *>()) {
            le->setDisabled(ro);
        }
    }
}

References KoDocumentInfoDlg::KoDocumentInfoDlgPrivate::aboutUi, d, and KoDocumentInfoDlg::KoDocumentInfoDlgPrivate::pages.

slotResetMetaData

void KoDocumentInfoDlg::slotResetMetaData ( )

privateslot

Connected with clicked() from pbReset - Reset parts of the metadata

Definition at line 234 of file KoDocumentInfoDlg.cpp.

{
    d->info->resetMetaData();
 
    if (!d->info->aboutInfo("creation-date").isEmpty()) {
        QDateTime t = QDateTime::fromString(d->info->aboutInfo("creation-date"),
                                            Qt::ISODate);
        QString s = QLocale().toString(t);
        d->aboutUi->lblCreated->setText(s + ", " +
                                        d->info->aboutInfo("initial-creator"));
    }
 
    if (!d->info->aboutInfo("date").isEmpty()) {
        QDateTime t = QDateTime::fromString(d->info->aboutInfo("date"), Qt::ISODate);
        QString s = QLocale().toString(t);
        d->aboutUi->lblModified->setText(s + ", " + d->info->authorInfo("creator"));
    }
 
    d->aboutUi->lblRevision->setText(d->info->aboutInfo("editing-cycles"));
}

References KoDocumentInfo::aboutInfo(), KoDocumentInfoDlg::KoDocumentInfoDlgPrivate::aboutUi, KoDocumentInfo::authorInfo(), d, KoDocumentInfoDlg::KoDocumentInfoDlgPrivate::info, and KoDocumentInfo::resetMetaData().

updateEditingTime()

void KoDocumentInfoDlg::updateEditingTime ( )

private

Definition at line 282 of file KoDocumentInfoDlg.cpp.

{
    const int timeElapsed = d->info->aboutInfo("editing-time").toInt();
 
    const int secondsElapsed = timeElapsed % 60;
    const int minutesElapsed = (timeElapsed / 60) % 60;
    const int hoursElapsed = (timeElapsed / 3600) % 24;
    const int daysElapsed = (timeElapsed / 86400) % 7;
    const int weeksElapsed = timeElapsed / 604800;
 
    QString majorTimeUnit;
    QString minorTimeUnit;
 
    if (weeksElapsed > 0) {
        majorTimeUnit = i18np("%1 week", "%1 weeks", weeksElapsed);
        minorTimeUnit = i18np("%1 day", "%1 days", daysElapsed);
    } else if (daysElapsed > 0) {
        majorTimeUnit = i18np("%1 day", "%1 days", daysElapsed);
        minorTimeUnit = i18np("%1 hour", "%1 hours", hoursElapsed);
    } else if (hoursElapsed > 0) {
        majorTimeUnit = i18np("%1 hour", "%1 hours", hoursElapsed);
        minorTimeUnit = i18np("%1 minute", "%1 minutes", minutesElapsed);
    } else if (minutesElapsed > 0) {
        majorTimeUnit = i18np("%1 minute", "%1 minutes", minutesElapsed);
        minorTimeUnit = i18np("%1 second", "%1 seconds", secondsElapsed);
    } else {
        d->aboutUi->lblEditing->setText(i18np("%1 second", "%1 seconds", secondsElapsed));
        return;
    }
 
    d->aboutUi->lblEditing->setText(i18nc(
                                        "major time unit and minor time unit",
                                        "%1 and %2",
                                        majorTimeUnit,
                                        minorTimeUnit
                                        ));
}

References KoDocumentInfo::aboutInfo(), KoDocumentInfoDlg::KoDocumentInfoDlgPrivate::aboutUi, d, and KoDocumentInfoDlg::KoDocumentInfoDlgPrivate::info.

Member Data Documentation

d

KoDocumentInfoDlgPrivate* const KoDocumentInfoDlg::d

private

Definition at line 88 of file KoDocumentInfoDlg.h.

---

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

• libs/ui/KoDocumentInfoDlg.h
• libs/ui/KoDocumentInfoDlg.cpp