Class: Wx::VersionInfo

Inherits:
Object
  • Object
show all
Defined in:
lib/wx/doc/gen/platform_info.rb

Overview

Note:

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

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.

Parameters:

  • name (String) (defaults to: ('')) —

    The name of the library or other entity that this object pertains to.

  • major (Integer) (defaults to: 0) —

    The major version component.

  • minor (Integer) (defaults to: 0) —

    The minor version component.

  • micro (Integer) (defaults to: 0) —

    The micro version component, 0 by default.

  • revision (Integer) (defaults to: 0) —

    The revision version component, also known as “build number”. This component is also 0 by default and is only available since wxWidgets 3.2.0.

  • description (String) (defaults to: ('')) —

    Free form description of this version, none by default.

  • copyright (String) (defaults to: ('')) —

    Copyright string, none by default.



437
 
# File 'lib/wx/doc/gen/platform_info.rb', line 437

def initialize(name=(''), major=0, minor=0, micro=0, revision=0, description=(''), copyright=('')) end

Instance Method Details

#at_least(major, minor = 0, micro = 0) ⇒ Boolean

Return true if the version is at least equal to the given one.

true if this version is equal to or greater than the given one.

Parameters:

  • major (Integer) —

    Major version to compare with.

  • minor (Integer) (defaults to: 0) —

    Optional minor version to compare with.

  • micro (Integer) (defaults to: 0) —

    Optional micro version to compare with.

Returns:

  • (Boolean) 


446
 
# File 'lib/wx/doc/gen/platform_info.rb', line 446

def at_least(major, minor=0, micro=0) end

#get_copyright ⇒ Wx::String Also known as: copyright

Get the copyright string.

The copyright string may be empty. The copyright string.

Returns:

  • (Wx::String) 


546
 
# File 'lib/wx/doc/gen/platform_info.rb', line 546

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.

Returns:

  • (Wx::String) 


530
 
# File 'lib/wx/doc/gen/platform_info.rb', line 530

def get_description; end

#get_major ⇒ Integer Also known as: major

Get the major version number.

Major version number.

Returns:

  • (Integer) 


466
 
# File 'lib/wx/doc/gen/platform_info.rb', line 466

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.

Returns:

  • (Integer) 


481
 
# File 'lib/wx/doc/gen/platform_info.rb', line 481

def get_micro; end

#get_minor ⇒ Integer Also known as: minor

Get the minor version number.

Minor version number.

Returns:

  • (Integer) 


473
 
# File 'lib/wx/doc/gen/platform_info.rb', line 473

def get_minor; end

#get_name ⇒ Wx::String Also known as: name

Get the name of the object (library).

Name string.

Returns:

  • (Wx::String) 


459
 
# File 'lib/wx/doc/gen/platform_info.rb', line 459

def get_name; end

#get_numeric_version_string ⇒ String Also known as: numeric_version_string

Get the string representation of only numeric version components.

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 “major.minor[.micro]”.

Returns:

  • (String) 


505
 
# File 'lib/wx/doc/gen/platform_info.rb', line 505

def get_numeric_version_string; 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.

Returns:

  • (Integer) 


489
 
# File 'lib/wx/doc/gen/platform_info.rb', line 489

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. Note that this function includes the name of the object this version is defined for, if this is undesired, use #get_numeric_version_string instead. The version string in the form “name major.minor[.micro]”.

Returns:

  • (String) 


514
 
# File 'lib/wx/doc/gen/platform_info.rb', line 514

def get_version_string; end

#has_copyright ⇒ Boolean Also known as: has_copyright?

Returns true if a copyright string has been specified.

Returns:

  • (Boolean)

See Also:



538
 
# File 'lib/wx/doc/gen/platform_info.rb', line 538

def has_copyright; end

#has_description ⇒ Boolean Also known as: has_description?

Return true if a description string has been specified.

Returns:

  • (Boolean)

See Also:



522
 
# File 'lib/wx/doc/gen/platform_info.rb', line 522

def has_description; end

#is_ok ⇒ Boolean Also known as: ok?

Return true if there is actually at least some version information.

For the default-constructed object, this function returns false, allowing to distinguish it from any object filled with the version information.

Returns:

  • (Boolean) 


452
 
# File 'lib/wx/doc/gen/platform_info.rb', line 452

def is_ok; 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.

Returns:

  • (String)

See Also:



498
 
# File 'lib/wx/doc/gen/platform_info.rb', line 498

def to_string; end