Differential D9401 Diff 24093 src/renderer/KReportRendererBase.h

Changeset View

Standalone View

View Options

src/renderer/KReportRendererBase.h

Show All 22 Lines
23#include <QUrl> 23​#include <QUrl>
24 24​
25#include "kreport_export.h" 25​#include "kreport_export.h"
26 26​
27class QPainter; 27​class QPainter;
28class QPrinter; 28​class QPrinter;
29class ORODocument; 29​class ORODocument;
30 30​
31//! Context for executing rendering. 31​/*!
32​ * @bref Context for executing rendering.
33​ */
32class KREPORT_EXPORT KReportRendererContext 34​class KREPORT_EXPORT KReportRendererContext
33{ 35​{
34 public: 36​ public:
35 KReportRendererContext(); 37​ KReportRendererContext();
36 ~KReportRendererContext(); 38​ ~KReportRendererContext();
37 39​
38 void setUrl(const QUrl& url); 40​ void setUrl(const QUrl& url);
39 void setPainter(QPainter* painter); 41​ void setPainter(QPainter* painter);
40 void setPrinter(QPrinter* printer); 42​ void setPrinter(QPrinter* printer);
41 43​
42 QPrinter *printer(); 44​ QPrinter *printer();
43 QPainter *painter(); 45​ QPainter *painter();
44 QPrinter *printer() const; 46​ QPrinter *printer() const;
45 QPainter *painter() const; 47​ QPainter *painter() const;
46 48​
47 QUrl url() const; 49​ QUrl url() const;
48 50​
49 private: 51​ private:
50 Q_DISABLE_COPY(KReportRendererContext) 52​ Q_DISABLE_COPY(KReportRendererContext)
51 class Private; 53​ class Private;
52 Private * const d; 54​ Private * const d;
53}; 55​};
54 56​
55//! Base class for report renderers. 57​/*!
58​ * @brief Base class for report renderers.
59​ *
staniekUnsubmitted
Not Done

I think after @brief we may need blank line or else all sentences get into the brief unless another command such as @todo or @note or @para is used.

staniek: I think after @brief we may need blank line or else all sentences get into the brief unless…
60​ * A renderer combines the report design with
61​ * data to produce a visual output
62​ */
56class KREPORT_EXPORT KReportRendererBase 63​class KREPORT_EXPORT KReportRendererBase
57{ 64​{
58 public: 65​ public:
59 KReportRendererBase(); 66​ KReportRendererBase();
60 67​
61 virtual ~KReportRendererBase(); 68​ virtual ~KReportRendererBase();
62 69​
63 //! Render the page of the given document within the given context. 70​ //! Render the page of the given document within the given context.
64 //! If page == -1, renders the entire document. 71​ //! If page == -1, renders the entire document.
65 virtual bool render(const KReportRendererContext& context, ORODocument *document, int page = -1) = 0; 72​ virtual bool render(const KReportRendererContext& context, ORODocument *document, int page = -1) = 0;
66}; 73​};
67 74​
68//! Factory for creating renderers 75​/*!
69//! @todo make it use plugins 76​ * @brief Factory for creating renderers
77​ * @todo make it use plugins
78​ */
70class KREPORT_EXPORT KReportRendererFactory 79​class KREPORT_EXPORT KReportRendererFactory
71{ 80​{
72 public: 81​ public:
73 KReportRendererFactory(); 82​ KReportRendererFactory();
74 ~KReportRendererFactory(); 83​ ~KReportRendererFactory();
75 84​
76 KReportRendererBase* createInstance(const QString& key); 85​ KReportRendererBase* createInstance(const QString& key);
77 86​
78 private: 87​ private:
79 Q_DISABLE_COPY(KReportRendererFactory) 88​ Q_DISABLE_COPY(KReportRendererFactory)
80 class Private; 89​ class Private;
81 Private * const d; 90​ Private * const d;
82}; 91​};
83 92​
84#endif // KREPORTRENDERERBASE_H 93​#endif // KREPORTRENDERERBASE_H