TagLib API Documentation
Public Member Functions | Related Functions | List of all members
TagLib::VersionNumber Class Reference

Version number with major, minor and patch segments. More...

#include <tversionnumber.h>

Public Member Functions

constexpr VersionNumber (unsigned int major, unsigned int minor, unsigned int patch=0)
 
constexpr unsigned int combinedVersion () const
 
constexpr unsigned int majorVersion () const
 
constexpr unsigned int minorVersion () const
 
constexpr unsigned int patchVersion () const
 
constexpr bool operator== (const VersionNumber &rhs) const
 
constexpr bool operator!= (const VersionNumber &rhs) const
 
constexpr bool operator< (const VersionNumber &rhs) const
 
constexpr bool operator> (const VersionNumber &rhs) const
 
constexpr bool operator<= (const VersionNumber &rhs) const
 
constexpr bool operator>= (const VersionNumber &rhs) const
 
String toString () const
 

Related Functions

(Note that these are not member functions.)

TAGLIB_EXPORT VersionNumber runtimeVersion ()
 

Detailed Description

Version number with major, minor and patch segments.

Constructor & Destructor Documentation

◆ VersionNumber()

constexpr TagLib::VersionNumber::VersionNumber ( unsigned int  major,
unsigned int  minor,
unsigned int  patch = 0 
)
inlineconstexpr

Constructs a version number from major, minor and patch segments.

Member Function Documentation

◆ combinedVersion()

constexpr unsigned int TagLib::VersionNumber::combinedVersion ( ) const
inlineconstexpr

Returns the version as an unsigned integer in the form (major version << 16) | (minor version << 8) | (patch version), e.g. 0x020100 for version 2.1.0.

◆ majorVersion()

constexpr unsigned int TagLib::VersionNumber::majorVersion ( ) const
inlineconstexpr

Returns the major version, e.g. 2

◆ minorVersion()

constexpr unsigned int TagLib::VersionNumber::minorVersion ( ) const
inlineconstexpr

Returns the minor version, e.g. 1

◆ operator!=()

constexpr bool TagLib::VersionNumber::operator!= ( const VersionNumber rhs) const
inlineconstexpr

Returns true if this version is not equal to rhs.

◆ operator<()

constexpr bool TagLib::VersionNumber::operator< ( const VersionNumber rhs) const
inlineconstexpr

Returns true if this version is less than rhs.

◆ operator<=()

constexpr bool TagLib::VersionNumber::operator<= ( const VersionNumber rhs) const
inlineconstexpr

Returns true if this version is less or equal than rhs.

◆ operator==()

constexpr bool TagLib::VersionNumber::operator== ( const VersionNumber rhs) const
inlineconstexpr

Returns true if this version is equal to rhs.

◆ operator>()

constexpr bool TagLib::VersionNumber::operator> ( const VersionNumber rhs) const
inlineconstexpr

Returns true if this version is greater than rhs.

◆ operator>=()

constexpr bool TagLib::VersionNumber::operator>= ( const VersionNumber rhs) const
inlineconstexpr

Returns true if this version is greater or equal than rhs.

◆ patchVersion()

constexpr unsigned int TagLib::VersionNumber::patchVersion ( ) const
inlineconstexpr

Returns the patch version, e.g. 0

◆ toString()

String TagLib::VersionNumber::toString ( ) const

Returns a string with major, minor, and patch versions separated by periods.

Friends And Related Function Documentation

◆ runtimeVersion()

TAGLIB_EXPORT VersionNumber runtimeVersion ( )
related

Returns the version number of TagLib in use at runtime. This does not need not be the version the application was compiled with.


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