VersionInfo

VersionInfo contains version information.

This class is used by wxWidgets to provide version information about the libraries it uses and itself, but you can also apply it in user space, to provide version information about your own libraries, or other libraries that you use.

New in version 2.9.2.

Inheritance Diagram

Inheritance diagram for class VersionInfo

Methods Summary

__init__	Constructor.
GetCopyright	Get the copyright string.
GetDescription	Get the description string.
GetMajor	Get the major version number.
GetMicro	Get the micro version, or release number.
GetMinor	Get the minor version number.
GetName	Get the name of the object (library).
GetVersionString	Get the string representation.
HasCopyright	Returns True if a copyright string has been specified.
HasDescription	Return True if a description string has been specified.
ToString	Get the string representation of this version object.

Properties Summary

Copyright	See GetCopyright
Description	See GetDescription
Major	See GetMajor
Micro	See GetMicro
Minor	See GetMinor
Name	See GetName
VersionString	See GetVersionString

Class API

---

class VersionInfo(object)

VersionInfo contains version information.

Possible constructors:

VersionInfo(name="", major=0, minor=0, micro=0, description="",
            copyright="")

Methods

---

__init__(self, name="", major=0, minor=0, micro=0, description="", copyright="")

Constructor.

The version information objects need to be initialized with this constructor and are immutable once they are created.

Parameters:

• name (string) – The name of the library or other entity that this object pertains to.
• major (int) – The major version component.
• minor (int) – The minor version component.
• micro (int) – The micro version component, 0 by default.
• description (string) – Free form description of this version, none by default.
• copyright (string) – Copyright string, none by default.

---

GetCopyright(self)

Get the copyright string.

The copyright string may be empty.

Return type:string Returns:The copyright string.

---

GetDescription(self)

Get the description string.

The description may be empty.

Return type:string Returns:The description string, free-form.

---

GetMajor(self)

Get the major version number.

Return type:int Returns:Major version number.

---

GetMicro(self)

Get the micro version, or release number.

Return type:int Returns:Micro version, or release number.

---

GetMinor(self)

Get the minor version number.

Return type:int Returns:Minor version number.

---

GetName(self)

Get the name of the object (library).

Return type:string Returns:Name string.

---

GetVersionString(self)

Get the string representation.

The micro component of the version is ignored/not used if it is 0.

Return type:string Returns:The version string in the form “name major.minor[.micro]”.

---

HasCopyright(self)

Returns True if a copyright string has been specified.

Return type:bool

See also

GetCopyright

---

HasDescription(self)

Return True if a description string has been specified.

Return type:bool

See also

GetDescription

---

ToString(self)

Get the string representation of this version object.

This function returns the description if it is non-empty or GetVersionString if there is no description.

Return type:string

See also

GetDescription , GetVersionString

Properties

---

Copyright

See GetCopyright

---

Description

See GetDescription

---

Major

See GetMajor

---

Micro

See GetMicro

---

Minor

See GetMinor

---

Name

See GetName

---

VersionString

See GetVersionString