QGIS API Documentation  3.17.0-Master (8af46bc54f)
Public Member Functions | List of all members
QgsProjectVersion Class Reference

A class to describe the version of a project. More...

#include <qgsprojectversion.h>

Public Member Functions

 QgsProjectVersion ()=default
 Creates a new NULL version. More...
 
 QgsProjectVersion (int major, int minor, int sub, const QString &name=QString())
 Constructor for QgsProjectVersion, with the specified major, minor and sub version numbers. More...
 
 QgsProjectVersion (const QString &string)
 Constructor for QgsProjectVersion, which parses the version number from a string. More...
 
bool isNull () const
 Returns true if this is a NULL project version. More...
 
int majorVersion () const
 Returns the major version number. More...
 
int minorVersion () const
 Returns the minor version number. More...
 
bool operator!= (const QgsProjectVersion &other) const
 Boolean not equal operator. More...
 
bool operator== (const QgsProjectVersion &other) const
 Boolean equal operator. More...
 
bool operator> (const QgsProjectVersion &other) const
 Boolean > operator. More...
 
bool operator>= (const QgsProjectVersion &other) const
 Boolean >= operator. More...
 
int subVersion () const
 Returns the sub version number. More...
 
QString text () const
 Returns a string representation of the version. More...
 

Detailed Description

A class to describe the version of a project.

Used in places where you need to check if the current version of QGIS is greater than the one used to create a project file.

Definition at line 31 of file qgsprojectversion.h.

Constructor & Destructor Documentation

◆ QgsProjectVersion() [1/3]

QgsProjectVersion::QgsProjectVersion ( )
default

Creates a new NULL version.

◆ QgsProjectVersion() [2/3]

QgsProjectVersion::QgsProjectVersion ( int  major,
int  minor,
int  sub,
const QString &  name = QString() 
)

Constructor for QgsProjectVersion, with the specified major, minor and sub version numbers.

Definition at line 24 of file qgsprojectversion.cpp.

◆ QgsProjectVersion() [3/3]

QgsProjectVersion::QgsProjectVersion ( const QString &  string)

Constructor for QgsProjectVersion, which parses the version number from a string.

Definition at line 32 of file qgsprojectversion.cpp.

Member Function Documentation

◆ isNull()

bool QgsProjectVersion::isNull ( ) const

Returns true if this is a NULL project version.

Definition at line 89 of file qgsprojectversion.cpp.

◆ majorVersion()

int QgsProjectVersion::majorVersion ( ) const
inline

Returns the major version number.

Definition at line 54 of file qgsprojectversion.h.

◆ minorVersion()

int QgsProjectVersion::minorVersion ( ) const
inline

Returns the minor version number.

Definition at line 59 of file qgsprojectversion.h.

◆ operator!=()

bool QgsProjectVersion::operator!= ( const QgsProjectVersion other) const

Boolean not equal operator.

Definition at line 58 of file qgsprojectversion.cpp.

◆ operator==()

bool QgsProjectVersion::operator== ( const QgsProjectVersion other) const

Boolean equal operator.

Definition at line 51 of file qgsprojectversion.cpp.

◆ operator>()

bool QgsProjectVersion::operator> ( const QgsProjectVersion other) const

Boolean > operator.

Definition at line 70 of file qgsprojectversion.cpp.

◆ operator>=()

bool QgsProjectVersion::operator>= ( const QgsProjectVersion other) const

Boolean >= operator.

Definition at line 65 of file qgsprojectversion.cpp.

◆ subVersion()

int QgsProjectVersion::subVersion ( ) const
inline

Returns the sub version number.

Definition at line 64 of file qgsprojectversion.h.

◆ text()

QString QgsProjectVersion::text ( ) const

Returns a string representation of the version.

Definition at line 77 of file qgsprojectversion.cpp.


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