Differential D547 Diff 1964 src/common/KReportPageSize.h

Changeset View

Standalone View

View Options

src/common/KReportPageSize.h

  • This file was added.
1​/* This file is part of the KDE project
2​ Copyright (C) 2015 by Adam Pigg <adam@piggz.co.uk>
3​
4​ This library is free software; you can redistribute it and/or
5​ modify it under the terms of the GNU Library General Public
6​ License as published by the Free Software Foundation; either
7​ version 2.1 of the License, or (at your option) any later version.
8​
9​ This library is distributed in the hope that it will be useful,
10​ but WITHOUT ANY WARRANTY; without even the implied warranty of
11​ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12​ Library General Public License for more details.
13​
14​ You should have received a copy of the GNU Library General Public License
15​ along with this library; see the file COPYING.LIB. If not, write to
16​ the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
17​ Boston, MA 02110-1301, USA.
18​*/
19​
20​#ifndef KREPORTPAGESIZE_H
21​#define KREPORTPAGESIZE_H
22​#include <QPageSize>
23​#include "kreport_export.h"
24​
25​/**
26​ * @brief Handle the page sizes we support in reports
staniekUnsubmitted
Not Done

I don't quite like the KReportPageSize namespace. It's still not only about page *sizes* but also formats.

First, let's look what are the differences to what the QPageSize delivers. More formats?

PS: "A4" translated name feels more user-friendly than "ISO A4".

staniek: I don't quite like the KReportPageSize namespace. It's still not only about page *sizes* but…
27​ *
piggzAuthorUnsubmitted
Not Done

Are you sure? All the namespace does is convert between string and QPageSizeId's .... if you are sure we can change it, but be sure :)

piggz: Are you sure? All the namespace does is convert between string and QPageSizeId's .... if you…
28​ * A group of helper functions and definitions of the page sizes
29​ * we support in KReport.
30​ *
staniekUnsubmitted
Done

How about using @return here and in each function below?

staniek: How about using @return here and in each function below?
31​ * We don't support all the sizes supported by Qt, so here we provide a list
32​ * of supported sizes and translatable descriptions, with helper functions to
staniekUnsubmitted
Not Done

There's QPageSize::name() which defined translated strings as names. How about using pageNames()?

staniek: There's QPageSize::name() which defined translated strings as names. How about using pageNames…
staniekUnsubmitted
Done

List -> list

staniek: List -> list
staniekUnsubmitted
Done

don't

staniek: don't
33​ * switch between QString and QPageSizeId
34​ *
35​ */
36​namespace KReportPageSize
37​{
staniekUnsubmitted
Done

There's QPageSize::key() which defines page format strings as keys. How about using pageKeys()?

staniek: There's QPageSize::key() which defines page format strings as keys. How about using pageKeys()?
38​
39​/**
40​ * @return list of translated names of all the available formats
41​ */
42​KREPORT_EXPORT QStringList pageFormatNames();
43​
staniekUnsubmitted
Done

-> pageFormatNames()

(synced the term with the QPageSize API)

staniek: -> pageFormatNames() (synced the term with the QPageSize API)
44​/**
staniekUnsubmitted
Done

Really done?

staniek: Really done?
45​ * @return list of non-translated names of all the available formats
46​ */
47​KREPORT_EXPORT QStringList pageFormatKeys();
48​
staniekUnsubmitted
Done

-> pageFormatKeys()

(synced the term with the QPageSize API)

staniek: -> pageFormatKeys() (synced the term with the QPageSize API)
staniekUnsubmitted
Done

Not done...

staniek: Not done...
49​/**
50​ * @return the default format (based on the default printer)
51​ */
52​KREPORT_EXPORT QPageSize::PageSizeId defaultSize();
staniekUnsubmitted
Done

Inconsistent. "format name" term used above in pageFormatNames(), and here "string".

I propose a change.

staniek: Inconsistent. "format name" term used above in pageFormatNames(), and here "string". I…
staniekUnsubmitted
Done

I propose change to:

/**

  • @return the page format key for the given size id */

QString pageFormatKey(QPageSize::PageSizeId pageSizeId);

staniek: I propose change to: /** * @return the page format key for the given size id */ QString…
53​
54​/**
55​ * @return the page size Id for the given key
56​ */
57​KREPORT_EXPORT QPageSize::PageSizeId pageSize(const QString& key);
58​
staniekUnsubmitted
Done

KREPORT_EXPORT QPageSize::PageSizeId pageFormatSize(const QString& key);

staniek: KREPORT_EXPORT QPageSize::PageSizeId pageFormatSize(const QString& key);
staniekUnsubmitted
Done

size -> key

staniek: size -> key
59​/**
60​ * @return the page size string for the given Id
61​ */
62​KREPORT_EXPORT QString pageSizeKey(QPageSize::PageSizeId id);
63​
staniekUnsubmitted
Done

QPageSize::PageSizeId -> QPageSize::PageSizeId id

staniek: QPageSize::PageSizeId -> QPageSize::PageSizeId id
64​
65​}
66​
67​#endif // KREPORTPAGESIZE_H