Class: Wx::VersionInfo
- Inherits:
-
Object
- Object
- Wx::VersionInfo
- Defined in:
- lib/wx/doc/gen/platform_info.rb
Overview
This class is untracked and should not be derived from nor instances extended!
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.
Category: Data Structures
Instance Method Summary collapse
-
#get_copyright ⇒ Wx::String
(also: #copyright)
Get the copyright string.
-
#get_description ⇒ Wx::String
(also: #description)
Get the description string.
-
#get_major ⇒ Integer
(also: #major)
Get the major version number.
-
#get_micro ⇒ Integer
(also: #micro)
Get the micro version, or release number.
-
#get_minor ⇒ Integer
(also: #minor)
Get the minor version number.
-
#get_name ⇒ Wx::String
(also: #name)
Get the name of the object (library).
-
#get_revision ⇒ Integer
(also: #revision)
Get the revision version, or build number.
-
#get_version_string ⇒ String
(also: #version_string)
Get the string representation.
-
#has_copyright ⇒ Boolean
(also: #has_copyright?)
Returns true if a copyright string has been specified.
-
#has_description ⇒ Boolean
(also: #has_description?)
Return true if a description string has been specified.
-
#initialize(name = (''), major = 0, minor = 0, micro = 0, revision = 0, description = (''), copyright = ('')) ⇒ Wx::VersionInfo
constructor
Constructor.
-
#to_string ⇒ String
Get the string representation of this version object.
Constructor Details
#initialize(name = (''), major = 0, minor = 0, micro = 0, revision = 0, description = (''), copyright = ('')) ⇒ Wx::VersionInfo
Constructor.
The version information objects need to be initialized with this constructor and are immutable once they are created.
416 |
# File 'lib/wx/doc/gen/platform_info.rb', line 416 def initialize(name=(''), major=0, minor=0, micro=0, revision=0, description=(''), copyright=('')) end |
Instance Method Details
#get_copyright ⇒ Wx::String Also known as: copyright
Get the copyright string.
The copyright string may be empty. The copyright string.
500 |
# File 'lib/wx/doc/gen/platform_info.rb', line 500 def get_copyright; end |
#get_description ⇒ Wx::String Also known as: description
Get the description string.
The description may be empty. The description string, free-form.
484 |
# File 'lib/wx/doc/gen/platform_info.rb', line 484 def get_description; end |
#get_major ⇒ Integer Also known as: major
Get the major version number.
Major version number.
429 |
# File 'lib/wx/doc/gen/platform_info.rb', line 429 def get_major; end |
#get_micro ⇒ Integer Also known as: micro
Get the micro version, or release number.
This is the third component of the version. Micro version, or release number.
444 |
# File 'lib/wx/doc/gen/platform_info.rb', line 444 def get_micro; end |
#get_minor ⇒ Integer Also known as: minor
Get the minor version number.
Minor version number.
436 |
# File 'lib/wx/doc/gen/platform_info.rb', line 436 def get_minor; end |
#get_name ⇒ Wx::String Also known as: name
Get the name of the object (library).
Name string.
422 |
# File 'lib/wx/doc/gen/platform_info.rb', line 422 def get_name; end |
#get_revision ⇒ Integer Also known as: revision
Get the revision version, or build number.
This is the fourth component of the version. Revision version, or build number.
452 |
# File 'lib/wx/doc/gen/platform_info.rb', line 452 def get_revision; end |
#get_version_string ⇒ String Also known as: version_string
Get the string representation.
The micro and revision components of the version are ignored/not used if they are both zero. If the revision component is non-zero all four parts will be used even if the micro component is zero. The version string in the form “name major.minor[.micro]”.
468 |
# File 'lib/wx/doc/gen/platform_info.rb', line 468 def get_version_string; end |
#has_copyright ⇒ Boolean Also known as: has_copyright?
Returns true if a copyright string has been specified.
492 |
# File 'lib/wx/doc/gen/platform_info.rb', line 492 def has_copyright; end |
#has_description ⇒ Boolean Also known as: has_description?
Return true if a description string has been specified.
476 |
# File 'lib/wx/doc/gen/platform_info.rb', line 476 def has_description; end |
#to_string ⇒ String
Get the string representation of this version object.
This function returns the description if it is non-empty or #get_version_string if there is no description.
461 |
# File 'lib/wx/doc/gen/platform_info.rb', line 461 def to_string; end |