QGIS API Documentation  3.17.0-Master (a84647cf30)
Signals | Public Member Functions | List of all members
QgsAlignmentComboBox Class Reference

A combo box which allows choice of alignment settings (e.g. More...

#include <qgsalignmentcombobox.h>

Inheritance diagram for QgsAlignmentComboBox:
Inheritance graph
[legend]

Signals

void changed ()
 Emitted when the alignment is changed. More...
 

Public Member Functions

 QgsAlignmentComboBox (QWidget *parent=nullptr)
 Constructor for QgsAlignmentComboBox, with the specified parent widget. More...
 
Qt::Alignment currentAlignment () const
 Returns the current alignment choice. More...
 
void customizeAlignmentDisplay (Qt::Alignment alignment, const QString &text=QString(), const QIcon &icon=QIcon())
 Sets the text and icon to use for a particular alignment option, replacing the default text or icon. More...
 
void setAvailableAlignments (Qt::Alignment alignments)
 Sets the available alignment choices shown in the combo box. More...
 
void setCurrentAlignment (Qt::Alignment alignment)
 Sets the current alignment choice. More...
 

Detailed Description

A combo box which allows choice of alignment settings (e.g.

left, right, ...).

Currently only horizontal alignments are supported. Available alignment choices can be manually specified by calling setAvailableAlignments(), which is useful when only a subset of Qt's alignment options should be exposed.

Since
QGIS 3.10

Definition at line 34 of file qgsalignmentcombobox.h.

Constructor & Destructor Documentation

◆ QgsAlignmentComboBox()

QgsAlignmentComboBox::QgsAlignmentComboBox ( QWidget *  parent = nullptr)

Constructor for QgsAlignmentComboBox, with the specified parent widget.

Definition at line 21 of file qgsalignmentcombobox.cpp.

Member Function Documentation

◆ changed

void QgsAlignmentComboBox::changed ( )
signal

Emitted when the alignment is changed.

◆ currentAlignment()

Qt::Alignment QgsAlignmentComboBox::currentAlignment ( ) const

Returns the current alignment choice.

See also
setCurrentAlignment()

Definition at line 39 of file qgsalignmentcombobox.cpp.

◆ customizeAlignmentDisplay()

void QgsAlignmentComboBox::customizeAlignmentDisplay ( Qt::Alignment  alignment,
const QString &  text = QString(),
const QIcon &  icon = QIcon() 
)

Sets the text and icon to use for a particular alignment option, replacing the default text or icon.

If text or icon is not specified, they will not be changed from the default.

Note
This must be called after first filtering the available alignment options via setAvailableAlignments().

Definition at line 51 of file qgsalignmentcombobox.cpp.

◆ setAvailableAlignments()

void QgsAlignmentComboBox::setAvailableAlignments ( Qt::Alignment  alignments)

Sets the available alignment choices shown in the combo box.

Definition at line 33 of file qgsalignmentcombobox.cpp.

◆ setCurrentAlignment()

void QgsAlignmentComboBox::setCurrentAlignment ( Qt::Alignment  alignment)

Sets the current alignment choice.

See also
currentAlignment()

Definition at line 44 of file qgsalignmentcombobox.cpp.


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