LibrePCB Developers Documentation
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
projectreadmerenderer.h
Go to the documentation of this file.
1/*
2 * LibrePCB - Professional EDA for everyone!
3 * Copyright (C) 2013 LibrePCB Developers, see AUTHORS.md for contributors.
4 * https://librepcb.org/
5 *
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 */
19
20#ifndef LIBREPCB_EDITOR_PROJECTREADMERENDERER_H
21#define LIBREPCB_EDITOR_PROJECTREADMERENDERER_H
22
23/*******************************************************************************
24 * Includes
25 ******************************************************************************/
27
28#include <QtCore>
29#include <QtGui>
30
31/*******************************************************************************
32 * Namespace / Forward Declarations
33 ******************************************************************************/
34namespace librepcb {
35namespace editor {
36
37/*******************************************************************************
38 * Class ProjectReadmeRenderer
39 ******************************************************************************/
40
44class ProjectReadmeRenderer : public QObject {
45 Q_OBJECT
46
47public:
48 // Constructors / Destructor
51 explicit ProjectReadmeRenderer(QObject* parent = nullptr) noexcept;
52 virtual ~ProjectReadmeRenderer() noexcept;
53
54 // General Methods
55 void request(const FilePath& fp, int width) noexcept;
56
57 // Operator Overloadings
58 ProjectReadmeRenderer& operator=(const ProjectReadmeRenderer& rhs) = delete;
59
60signals:
61 void runningChanged(bool running);
62 void finished(const QPixmap& result);
63
64private:
65 void start() noexcept;
66 static QPixmap render(const FilePath& fp, int width) noexcept;
67
68private:
70 int mWidth;
72 std::unique_ptr<QFutureWatcher<QPixmap>> mWatcher;
73};
74
75/*******************************************************************************
76 * End of File
77 ******************************************************************************/
78
79} // namespace editor
80} // namespace librepcb
81
82#endif
This class represents absolute, well-formatted paths to files or directories.
Definition filepath.h:127
Renders a README.md or other file types as a QPixmap.
Definition projectreadmerenderer.h:44
std::unique_ptr< QFutureWatcher< QPixmap > > mWatcher
Definition projectreadmerenderer.h:72
void finished(const QPixmap &result)
void request(const FilePath &fp, int width) noexcept
Definition projectreadmerenderer.cpp:57
FilePath mPath
Definition projectreadmerenderer.h:69
ProjectReadmeRenderer(const ProjectReadmeRenderer &other)=delete
int mWidth
Definition projectreadmerenderer.h:70
QTimer mDelayTimer
Definition projectreadmerenderer.h:71
static QPixmap render(const FilePath &fp, int width) noexcept
Definition projectreadmerenderer.cpp:108
void start() noexcept
Definition projectreadmerenderer.cpp:75
Definition occmodel.cpp:77
Definition uuid.h:186