LibrePCB Developers Documentation
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
ProjectReadmeRenderer Class Reference

Renders a README.md or other file types as a QPixmap. More...

#include <projectreadmerenderer.h>

Inherits QObject.

+ Collaboration diagram for ProjectReadmeRenderer:

Signals

void runningChanged (bool running)
 
void finished (const QPixmap &result)
 

Public Member Functions

 ProjectReadmeRenderer ()=delete
 
 ProjectReadmeRenderer (const ProjectReadmeRenderer &other)=delete
 
 ProjectReadmeRenderer (QObject *parent=nullptr) noexcept
 
virtual ~ProjectReadmeRenderer () noexcept
 
void request (const FilePath &fp, int width) noexcept
 
ProjectReadmeRendereroperator= (const ProjectReadmeRenderer &rhs)=delete
 

Private Member Functions

void start () noexcept
 

Static Private Member Functions

static QPixmap render (const FilePath &fp, int width) noexcept
 

Private Attributes

FilePath mPath
 
int mWidth
 
QTimer mDelayTimer
 
std::unique_ptr< QFutureWatcher< QPixmap > > mWatcher
 

Detailed Description

Renders a README.md or other file types as a QPixmap.

Constructor & Destructor Documentation

◆ ProjectReadmeRenderer() [1/3]

◆ ProjectReadmeRenderer() [2/3]

ProjectReadmeRenderer ( const ProjectReadmeRenderer other)
delete

◆ ProjectReadmeRenderer() [3/3]

ProjectReadmeRenderer ( QObject *  parent = nullptr)
explicitnoexcept
+ Here is the call graph for this function:

◆ ~ProjectReadmeRenderer()

~ProjectReadmeRenderer ( )
virtualnoexcept

Member Function Documentation

◆ request()

void request ( const FilePath fp,
int  width 
)
noexcept

◆ operator=()

ProjectReadmeRenderer & operator= ( const ProjectReadmeRenderer rhs)
delete

◆ runningChanged

void runningChanged ( bool  running)
signal
+ Here is the caller graph for this function:

◆ finished

void finished ( const QPixmap &  result)
signal
+ Here is the caller graph for this function:

◆ start()

void start ( )
privatenoexcept
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ render()

QPixmap render ( const FilePath fp,
int  width 
)
staticprivatenoexcept
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Member Data Documentation

◆ mPath

FilePath mPath
private

◆ mWidth

int mWidth
private

◆ mDelayTimer

QTimer mDelayTimer
private

◆ mWatcher

std::unique_ptr<QFutureWatcher<QPixmap> > mWatcher
private

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