QGIS API Documentation  2.5.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
Public Types | Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | 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]
Collaboration diagram for QgsPreviewEffect:
Collaboration graph
[legend]

Public Types

enum  PreviewMode { PreviewGrayscale, PreviewMono, PreviewProtanope, PreviewDeuteranope }
 

Public Member Functions

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

Protected Member Functions

virtual void draw (QPainter *painter)
 

Private Member Functions

QRgb simulateColorBlindness (QRgb &originalColor, PreviewMode type)
 
void simulateProtanopeLMS (double &L, double &M, double &S)
 
void simulateDeuteranopeLMS (double &L, double &M, double &S)
 

Private Attributes

PreviewMode mMode
 

Detailed Description

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

Definition at line 28 of file qgsprevieweffect.h.

Constructor & Destructor Documentation

QgsPreviewEffect::QgsPreviewEffect ( QObject *  parent)

Definition at line 22 of file qgsprevieweffect.cpp.

QgsPreviewEffect::~QgsPreviewEffect ( )

Definition at line 30 of file qgsprevieweffect.cpp.

Member Function Documentation

void QgsPreviewEffect::draw ( QPainter *  painter)
protectedvirtual
PreviewMode QgsPreviewEffect::mode ( ) const
inline

Returns the mode used for the preview effect.

Returns
PreviewMode currently used by the effect
Note
added in 2.3
See also
setMode

Definition at line 55 of file qgsprevieweffect.h.

Referenced by QgsMapCanvas::previewMode(), and 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
Note
added in 2.3
See also
mode

Definition at line 35 of file qgsprevieweffect.cpp.

References mMode, and mode().

Referenced by QgsComposerView::setPreviewMode(), and QgsMapCanvas::setPreviewMode().

QRgb QgsPreviewEffect::simulateColorBlindness ( QRgb &  originalColor,
QgsPreviewEffect::PreviewMode  mode 
)
private
void QgsPreviewEffect::simulateDeuteranopeLMS ( double &  L,
double &  M,
double &  S 
)
private

Definition at line 152 of file qgsprevieweffect.cpp.

Referenced by simulateColorBlindness().

void QgsPreviewEffect::simulateProtanopeLMS ( double &  L,
double &  M,
double &  S 
)
private

Definition at line 145 of file qgsprevieweffect.cpp.

Referenced by simulateColorBlindness().

Member Data Documentation

PreviewMode QgsPreviewEffect::mMode
private

Definition at line 62 of file qgsprevieweffect.h.

Referenced by draw(), and setMode().


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