Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
QTypeRevision Class Reference

\inmodule QtCore More...

#include <qtyperevision.h>

Collaboration diagram for QTypeRevision:

Public Types

template<typename Integer>
using if_valid_segment_type
template<typename Integer>
using if_valid_value_type

Public Member Functions

constexpr QTypeRevision ()=default
 Produces an invalid revision.
constexpr bool hasMajorVersion () const
 Returns true if the major version is known, otherwise false.
constexpr quint8 majorVersion () const
 Returns the major version encoded in the revision.
constexpr bool hasMinorVersion () const
 Returns true if the minor version is known, otherwise false.
constexpr quint8 minorVersion () const
 Returns the minor version encoded in the revision.
constexpr bool isValid () const
 Returns true if the major version or the minor version is known, otherwise false.
template<typename Integer, if_valid_value_type< Integer > = true>
constexpr Integer toEncodedVersion () const
 Transforms the revision into an integer value, encoding the minor version into the least significant byte, and the major version into the second least significant byte.

Static Public Member Functions

template<typename Integer, if_valid_segment_type< Integer > = true>
static constexpr bool isValidSegment (Integer segment)
 Returns true if the given number can be used as either major or minor version in a QTypeRevision.
template<typename Major, typename Minor, if_valid_segment_type< Major > = true, if_valid_segment_type< Minor > = true>
static constexpr QTypeRevision fromVersion (Major majorVersion, Minor minorVersion)
 Produces a QTypeRevision from the given majorVersion and minorVersion, both of which need to be a valid segments.
template<typename Major, if_valid_segment_type< Major > = true>
static constexpr QTypeRevision fromMajorVersion (Major majorVersion)
 Produces a QTypeRevision from the given majorVersion with an invalid minor version.
template<typename Minor, if_valid_segment_type< Minor > = true>
static constexpr QTypeRevision fromMinorVersion (Minor minorVersion)
 Produces a QTypeRevision from the given minorVersion with an invalid major version.
template<typename Integer, if_valid_value_type< Integer > = true>
static constexpr QTypeRevision fromEncodedVersion (Integer value)
 Produces a QTypeRevision from the given value.
static constexpr QTypeRevision zero ()
 Produces a QTypeRevision with major and minor version {0}.

Friends

constexpr bool comparesEqual (const QTypeRevision &lhs, const QTypeRevision &rhs) noexcept
constexpr Qt::strong_ordering compareThreeWay (const QTypeRevision &lhs, const QTypeRevision &rhs) noexcept

(Note that these are not member symbols.)

QDataStream & operator<< (QDataStream &out, const QTypeRevision &revision)
QDataStream & operator>> (QDataStream &in, QTypeRevision &revision)

Detailed Description

\inmodule QtCore

Since
6.0

The QTypeRevision class contains a lightweight representation of a version number with two 8-bit segments, major and minor, either of which can be unknown. \compares strong

Use this class to describe revisions of a type. Compatible revisions can be expressed as increments of the minor version. Breaking changes can be expressed as increments of the major version. The return values of \l QMetaMethod::revision() and \l QMetaProperty::revision() can be passed to \l QTypeRevision::fromEncodedVersion(). The resulting major and minor versions specify in which Qt versions the properties and methods were added.

See also
QMetaMethod::revision(), QMetaProperty::revision()

Definition at line 30 of file qtyperevision.h.

Member Typedef Documentation

◆ if_valid_segment_type

template<typename Integer>
using QTypeRevision::if_valid_segment_type
Initial value:
typename std::enable_if<
std::is_integral<Integer>::value, bool>::type
type
GLenum type
Definition qopengles2ext.h:150

Definition at line 34 of file qtyperevision.h.

◆ if_valid_value_type

template<typename Integer>
using QTypeRevision::if_valid_value_type
Initial value:
typename std::enable_if<
std::is_integral<Integer>::value
&& (sizeof(Integer) > sizeof(quint16)
|| (sizeof(Integer) == sizeof(quint16)
&& !std::is_signed<Integer>::value)), bool>::type
XFA_AttributeType::Integer
@ Integer
Definition fxfa_basic.h:87
quint16
unsigned short quint16
Definition qtypes.h:53

Definition at line 38 of file qtyperevision.h.

Constructor & Destructor Documentation

◆ QTypeRevision()

QTypeRevision::QTypeRevision ( )
constexprdefault

Produces an invalid revision.

See also
isValid()

Referenced by Moc::parseRevision().

Here is the caller graph for this function:

Member Function Documentation

◆ fromEncodedVersion()

template<typename Integer, if_valid_value_type< Integer > = true>
constexpr QTypeRevision QTypeRevision::fromEncodedVersion ( Integer value)
inlinestaticconstexpr

Produces a QTypeRevision from the given value.

value encodes both the minor and major versions in the least significant and second least significant byte, respectively.

value must not have any bits outside the least significant two bytes set. Integer needs to be at least 16 bits wide, and must not have a sign bit in the least significant 16 bits.

See also
toEncodedVersion()

Definition at line 80 of file qtyperevision.h.

◆ fromMajorVersion()

template<typename Major, if_valid_segment_type< Major > = true>
constexpr QTypeRevision QTypeRevision::fromMajorVersion ( Major majorVersion)
inlinestaticconstexpr

Produces a QTypeRevision from the given majorVersion with an invalid minor version.

majorVersion needs to be a valid segment.

See also
isValidSegment()

Definition at line 66 of file qtyperevision.h.

◆ fromMinorVersion()

template<typename Minor, if_valid_segment_type< Minor > = true>
constexpr QTypeRevision QTypeRevision::fromMinorVersion ( Minor minorVersion)
inlinestaticconstexpr

Produces a QTypeRevision from the given minorVersion with an invalid major version.

minorVersion needs to be a valid segment.

See also
isValidSegment()

Definition at line 73 of file qtyperevision.h.

◆ fromVersion()

template<typename Major, typename Minor, if_valid_segment_type< Major > = true, if_valid_segment_type< Minor > = true>
constexpr QTypeRevision QTypeRevision::fromVersion ( Major majorVersion,
Minor minorVersion )
inlinestaticconstexpr

Produces a QTypeRevision from the given majorVersion and minorVersion, both of which need to be a valid segments.

See also
isValidSegment()

Definition at line 58 of file qtyperevision.h.

◆ hasMajorVersion()

bool QTypeRevision::hasMajorVersion ( ) const
inlineconstexpr

Returns true if the major version is known, otherwise false.

See also
majorVersion(), hasMinorVersion()

Definition at line 90 of file qtyperevision.h.

◆ hasMinorVersion()

bool QTypeRevision::hasMinorVersion ( ) const
inlineconstexpr

Returns true if the minor version is known, otherwise false.

See also
minorVersion(), hasMajorVersion()

Definition at line 93 of file qtyperevision.h.

◆ isValid()

bool QTypeRevision::isValid ( ) const
inlineconstexpr

Returns true if the major version or the minor version is known, otherwise false.

See also
hasMajorVersion(), hasMinorVersion()

Definition at line 96 of file qtyperevision.h.

◆ isValidSegment()

template<typename Integer, if_valid_segment_type< Integer > = true>
constexpr bool QTypeRevision::isValidSegment ( Integer segment)
inlinestaticconstexpr

Returns true if the given number can be used as either major or minor version in a QTypeRevision.

The valid range for segment is {>= 0} and {< 255}.

Definition at line 45 of file qtyperevision.h.

◆ majorVersion()

quint8 QTypeRevision::majorVersion ( ) const
inlineconstexpr

Returns the major version encoded in the revision.

See also
hasMajorVersion(), minorVersion()

Definition at line 91 of file qtyperevision.h.

◆ minorVersion()

quint8 QTypeRevision::minorVersion ( ) const
inlineconstexpr

Returns the minor version encoded in the revision.

See also
hasMinorVersion(), majorVersion()

Definition at line 94 of file qtyperevision.h.

◆ toEncodedVersion()

template<typename Integer, if_valid_value_type< Integer > = true>
Integer QTypeRevision::toEncodedVersion ( ) const
inlineconstexpr

Transforms the revision into an integer value, encoding the minor version into the least significant byte, and the major version into the second least significant byte.

Integer needs to be at least 16 bits wide, and must not have a sign bit in the least significant 16 bits.

See also
fromEncodedVersion()

Definition at line 99 of file qtyperevision.h.

◆ zero()

constexpr QTypeRevision QTypeRevision::zero ( )
inlinestaticconstexpr

Produces a QTypeRevision with major and minor version {0}.

Definition at line 86 of file qtyperevision.h.

◆ comparesEqual

bool comparesEqual ( const QTypeRevision & lhs,
const QTypeRevision & rhs )
friend

Definition at line 106 of file qtyperevision.h.

◆ compareThreeWay

Qt::strong_ordering compareThreeWay ( const QTypeRevision & lhs,
const QTypeRevision & rhs )
friend

Definition at line 109 of file qtyperevision.h.

◆ operator<<()

QDataStream & operator<< ( QDataStream & out,
const QTypeRevision & revision )
related
Since
6.0

Writes the revision revision to stream out.

Definition at line 165 of file qtyperevision.cpp.

◆ operator>>()

QDataStream & operator>> ( QDataStream & in,
QTypeRevision & revision )
related
Since
6.0

Reads a revision from stream in and stores it in revision.

Definition at line 177 of file qtyperevision.cpp.

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