QGIS API Documentation 3.29.0-Master (19d7edcfed)
Public Types | Public Member Functions | Static Public Member Functions | List of all members
QgsLegendStyle Class Reference

Contains detailed styling information relating to how a layout legend should be rendered. More...

#include <qgslegendstyle.h>

Public Types

enum  Side { Top = 0 , Bottom = 1 , Left = 2 , Right = 3 }
 Margin sides. More...
 
enum  Style {
  Undefined , Hidden , Title , Group ,
  Subgroup , Symbol , SymbolLabel
}
 Component of legends which can be styled. More...
 

Public Member Functions

 QgsLegendStyle ()
 
Qt::Alignment alignment () const
 Returns the alignment for the legend component. More...
 
Q_DECL_DEPRECATED QFont font () const
 Returns the font used for rendering this legend component. More...
 
double indent () const
 Returns the indent (in mm) of a group or subgroup. More...
 
double margin (Side side)
 Returns the margin (in mm) for the specified side of the component. More...
 
void readXml (const QDomElement &elem, const QDomDocument &doc, const QgsReadWriteContext &context=QgsReadWriteContext())
 Reads the component's style definition from an XML element. More...
 
void setAlignment (Qt::Alignment alignment)
 Sets the alignment for the legend component. More...
 
Q_DECL_DEPRECATED void setFont (const QFont &font)
 Sets the font used for rendering this legend component. More...
 
void setIndent (double indent)
 Sets the indent (in mm) of a group or subgroup. More...
 
void setMargin (double margin)
 Sets all margin sides to the same margin size (in mm). More...
 
void setMargin (Side side, double margin)
 Sets the margin (in mm) for the specified side of the component. More...
 
void setTextFormat (const QgsTextFormat &format)
 Sets the text format used for rendering this legend component. More...
 
QgsTextFormattextFormat ()
 Returns the text format used for rendering this legend component. More...
 
QgsTextFormat textFormat () const
 Returns the text format used for rendering this legend component. More...
 
void writeXml (const QString &name, QDomElement &elem, QDomDocument &doc, const QgsReadWriteContext &context=QgsReadWriteContext()) const
 Writes the component's style definition to an XML element. More...
 

Static Public Member Functions

static Style styleFromName (const QString &styleName)
 Returns the style from name string. More...
 
static QString styleLabel (Style s)
 Returns a translated string representing a style component, for use in UI. More...
 
static QString styleName (Style s)
 Returns the name for a style component as a string. More...
 

Detailed Description

Contains detailed styling information relating to how a layout legend should be rendered.

Definition at line 36 of file qgslegendstyle.h.

Member Enumeration Documentation

◆ Side

Margin sides.

Enumerator
Top 

Top side.

Bottom 

Bottom side.

Left 

Left side.

Right 

Right side.

Definition at line 55 of file qgslegendstyle.h.

◆ Style

Component of legends which can be styled.

Enumerator
Undefined 

Should not happen, only if corrupted project file.

Hidden 

Special style, item is hidden including margins around.

Title 

Legend title.

Group 

Legend group title.

Subgroup 

Legend subgroup title.

Symbol 

Symbol icon (excluding label)

SymbolLabel 

Symbol label (excluding icon)

Definition at line 41 of file qgslegendstyle.h.

Constructor & Destructor Documentation

◆ QgsLegendStyle()

QgsLegendStyle::QgsLegendStyle ( )

Definition at line 31 of file qgslegendstyle.cpp.

Member Function Documentation

◆ alignment()

Qt::Alignment QgsLegendStyle::alignment ( ) const
inline

Returns the alignment for the legend component.

See also
setAlignment()
Since
QGIS 3.10

Definition at line 130 of file qgslegendstyle.h.

◆ font()

Q_DECL_DEPRECATED QFont QgsLegendStyle::font ( ) const
inline

Returns the font used for rendering this legend component.

See also
setFont()
Deprecated:
use textFormat() instead

Definition at line 70 of file qgslegendstyle.h.

◆ indent()

double QgsLegendStyle::indent ( ) const
inline

Returns the indent (in mm) of a group or subgroup.

See also
indent()
Since
QGIS 3.22

Definition at line 146 of file qgslegendstyle.h.

◆ margin()

double QgsLegendStyle::margin ( Side  side)
inline

Returns the margin (in mm) for the specified side of the component.

Note
Not all legend components respect all margin side settings!
See also
setMargin()

Definition at line 107 of file qgslegendstyle.h.

◆ readXml()

void QgsLegendStyle::readXml ( const QDomElement &  elem,
const QDomDocument &  doc,
const QgsReadWriteContext context = QgsReadWriteContext() 
)

Reads the component's style definition from an XML element.

See also
writeXml()

Definition at line 84 of file qgslegendstyle.cpp.

◆ setAlignment()

void QgsLegendStyle::setAlignment ( Qt::Alignment  alignment)
inline

Sets the alignment for the legend component.

See also
alignment()
Since
QGIS 3.10

Definition at line 138 of file qgslegendstyle.h.

◆ setFont()

void QgsLegendStyle::setFont ( const QFont &  font)

Sets the font used for rendering this legend component.

See also
font()
Deprecated:
use setTextFormat() instead

Definition at line 35 of file qgslegendstyle.cpp.

◆ setIndent()

void QgsLegendStyle::setIndent ( double  indent)
inline

Sets the indent (in mm) of a group or subgroup.

See also
indent()
Since
QGIS 3.22

Definition at line 154 of file qgslegendstyle.h.

◆ setMargin() [1/2]

void QgsLegendStyle::setMargin ( double  margin)

Sets all margin sides to the same margin size (in mm).

See also
margin()

Definition at line 50 of file qgslegendstyle.cpp.

◆ setMargin() [2/2]

void QgsLegendStyle::setMargin ( Side  side,
double  margin 
)
inline

Sets the margin (in mm) for the specified side of the component.

Note
Not all legend components respect all margin side settings!
See also
margin()

Definition at line 116 of file qgslegendstyle.h.

◆ setTextFormat()

void QgsLegendStyle::setTextFormat ( const QgsTextFormat format)
inline

Sets the text format used for rendering this legend component.

See also
textFormat()
Since
QGIS 3.30

Definition at line 98 of file qgslegendstyle.h.

◆ styleFromName()

QgsLegendStyle::Style QgsLegendStyle::styleFromName ( const QString &  styleName)
static

Returns the style from name string.

See also
styleName()

Definition at line 136 of file qgslegendstyle.cpp.

◆ styleLabel()

QString QgsLegendStyle::styleLabel ( Style  s)
static

Returns a translated string representing a style component, for use in UI.

See also
styleName()

Definition at line 153 of file qgslegendstyle.cpp.

◆ styleName()

QString QgsLegendStyle::styleName ( Style  s)
static

Returns the name for a style component as a string.

This is a non-localised version, for internal use.

See also
styleFromName()
styleLabel()

Definition at line 114 of file qgslegendstyle.cpp.

◆ textFormat() [1/2]

QgsTextFormat & QgsLegendStyle::textFormat ( )
inline

Returns the text format used for rendering this legend component.

See also
setTextFormat()
Since
QGIS 3.30

Definition at line 84 of file qgslegendstyle.h.

◆ textFormat() [2/2]

QgsTextFormat QgsLegendStyle::textFormat ( ) const
inline

Returns the text format used for rendering this legend component.

See also
setTextFormat()
Since
QGIS 3.30

Definition at line 91 of file qgslegendstyle.h.

◆ writeXml()

void QgsLegendStyle::writeXml ( const QString &  name,
QDomElement &  elem,
QDomDocument &  doc,
const QgsReadWriteContext context = QgsReadWriteContext() 
) const

Writes the component's style definition to an XML element.

See also
readXml()

Definition at line 58 of file qgslegendstyle.cpp.


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