QGIS API Documentation  3.27.0-Master (11ef3e5184)
Public Slots | Public Member Functions | List of all members
QgsBlendModeComboBox Class Reference

A combobox which lets the user select blend modes from a predefined list. More...

#include <qgsblendmodecombobox.h>

Inheritance diagram for QgsBlendModeComboBox:
Inheritance graph
[legend]

Public Slots

void updateModes ()
 Populates the blend mode combo box, and sets up mapping for blend modes to combo box indexes. More...
 

Public Member Functions

 QgsBlendModeComboBox (QWidget *parent=nullptr)
 Constructor for QgsBlendModeComboBox. More...
 
QPainter::CompositionMode blendMode ()
 Returns the selected blend mode. More...
 
void setBlendMode (QPainter::CompositionMode blendMode)
 Sets the selected blend mode. More...
 
void setShowClippingModes (bool show)
 Sets whether composition modes which cause clipping are shown in the combo box. More...
 
bool showClippingModes () const
 Returns true if composition modes which cause clipping are shown in the combo box. More...
 

Detailed Description

A combobox which lets the user select blend modes from a predefined list.

Definition at line 30 of file qgsblendmodecombobox.h.

Constructor & Destructor Documentation

◆ QgsBlendModeComboBox()

QgsBlendModeComboBox::QgsBlendModeComboBox ( QWidget *  parent = nullptr)

Constructor for QgsBlendModeComboBox.

Definition at line 28 of file qgsblendmodecombobox.cpp.

Member Function Documentation

◆ blendMode()

QPainter::CompositionMode QgsBlendModeComboBox::blendMode ( )

Returns the selected blend mode.

See also
setBlendMode()

Definition at line 75 of file qgsblendmodecombobox.cpp.

◆ setBlendMode()

void QgsBlendModeComboBox::setBlendMode ( QPainter::CompositionMode  blendMode)

Sets the selected blend mode.

See also
blendMode()

Definition at line 80 of file qgsblendmodecombobox.cpp.

◆ setShowClippingModes()

void QgsBlendModeComboBox::setShowClippingModes ( bool  show)

Sets whether composition modes which cause clipping are shown in the combo box.

By default, these composition modes (such as QPainter::CompositionMode::CompositionMode_DestinationIn ) are not shown in the combo box, as they can only be used with predictable results in a limited set of circumstances. By setting show to true these additional composition modes will be shown in the combo box.

See also
showClippingModes()
Since
QGIS 3.24

Definition at line 85 of file qgsblendmodecombobox.cpp.

◆ showClippingModes()

bool QgsBlendModeComboBox::showClippingModes ( ) const

Returns true if composition modes which cause clipping are shown in the combo box.

By default, these composition modes (such as QPainter::CompositionMode::CompositionMode_DestinationIn ) are not shown in the combo box, as they can only be used with predictable results in a limited set of circumstances.

See also
setShowClippingModes()
Since
QGIS 3.24

Definition at line 94 of file qgsblendmodecombobox.cpp.

◆ updateModes

void QgsBlendModeComboBox::updateModes ( )
slot

Populates the blend mode combo box, and sets up mapping for blend modes to combo box indexes.

Definition at line 35 of file qgsblendmodecombobox.cpp.


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