QGIS API Documentation  2.99.0-Master (19b062c)
Public Types | Public Member Functions | Protected Member Functions | List of all members
QgsPreviewEffect Class Reference

A graphics effect which can be applied to a widget to simulate various printing and color blindness modes. More...

#include <qgsprevieweffect.h>

Inheritance diagram for QgsPreviewEffect:
Inheritance graph
[legend]

Public Types

enum  PreviewMode { PreviewGrayscale, PreviewMono, PreviewProtanope, PreviewDeuteranope }
 

Public Member Functions

 QgsPreviewEffect (QObject *parent)
 
PreviewMode mode () const
 Returns the mode used for the preview effect. More...
 
void setMode (PreviewMode mode)
 Sets the mode for the preview effect, which controls how the effect modifies a widgets appearance. More...
 

Protected Member Functions

virtual void draw (QPainter *painter) override
 

Detailed Description

A graphics effect which can be applied to a widget to simulate various printing and color blindness modes.

Definition at line 31 of file qgsprevieweffect.h.

Member Enumeration Documentation

◆ PreviewMode

Enumerator
PreviewGrayscale 
PreviewMono 
PreviewProtanope 
PreviewDeuteranope 

Definition at line 36 of file qgsprevieweffect.h.

Constructor & Destructor Documentation

◆ QgsPreviewEffect()

QgsPreviewEffect::QgsPreviewEffect ( QObject *  parent)

Definition at line 22 of file qgsprevieweffect.cpp.

Member Function Documentation

◆ draw()

void QgsPreviewEffect::draw ( QPainter *  painter)
overrideprotectedvirtual

Definition at line 36 of file qgsprevieweffect.cpp.

◆ mode()

PreviewMode QgsPreviewEffect::mode ( ) const
inline

Returns the mode used for the preview effect.

Returns
PreviewMode currently used by the effect
Since
QGIS 2.3
See also
setMode

Definition at line 60 of file qgsprevieweffect.h.

◆ setMode()

void QgsPreviewEffect::setMode ( QgsPreviewEffect::PreviewMode  mode)

Sets the mode for the preview effect, which controls how the effect modifies a widgets appearance.

Parameters
modePreviewMode to use to draw the widget
Since
QGIS 2.3
See also
mode

Definition at line 30 of file qgsprevieweffect.cpp.


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