**********************
wx.PlatformInformation
**********************

Inheritance diagram for `wx.PlatformInformation`:

|

.. inheritance-diagram:: wx.PlatformInformation

|

Description
===========

Proxy of C++ PlatformInformation class. 

This class holds informations about the operating system and the toolkit that the application is running under and some basic architecture info of the machine where it's running.

.. seealso:: `wx.GetOSVersion <../wxFunctions.html#GetOSVersion>`_, `wx.IsPlatformLittleEndian <../wxFunctions.html#IsPlatformLittleEndian>`_,
   `wx.IsPlatform64Bit <../wxFunctions.html#IsPlatform64Bit>`_


Methods Summary
^^^^^^^^^^^^^^^

* `__init__ <#__init__>`_ 
* `CheckOSVersion <#CheckOSVersion>`_ 
* `CheckToolkitVersion <#CheckToolkitVersion>`_ 
* `GetArchName <#GetArchName>`_ 
* `GetArchitecture <#GetArchitecture>`_ 
* `GetEndianness <#GetEndianness>`_ 
* `GetEndiannessName <#GetEndiannessName>`_ 
* `GetOSMajorVersion <#GetOSMajorVersion>`_ 
* `GetOSMinorVersion <#GetOSMinorVersion>`_ 
* `GetOperatingSystemFamilyName <#GetOperatingSystemFamilyName>`_ 
* `GetOperatingSystemId <#GetOperatingSystemId>`_ 
* `GetOperatingSystemIdName <#GetOperatingSystemIdName>`_ 
* `GetPortId <#GetPortId>`_ 
* `GetPortIdName <#GetPortIdName>`_ 
* `GetPortIdShortName <#GetPortIdShortName>`_ 
* `GetToolkitMajorVersion <#GetToolkitMajorVersion>`_ 
* `GetToolkitMinorVersion <#GetToolkitMinorVersion>`_ 
* `IsOk <#IsOk>`_ 
* `IsUsingUniversalWidgets <#IsUsingUniversalWidgets>`_ 
* `SetArchitecture <#SetArchitecture>`_ 
* `SetEndianness <#SetEndianness>`_ 
* `SetOSVersion <#SetOSVersion>`_ 
* `SetOperatingSystemId <#SetOperatingSystemId>`_ 
* `SetPortId <#SetPortId>`_ 
* `SetToolkitVersion <#SetToolkitVersion>`_ 

Properties Summary
^^^^^^^^^^^^^^^^^^

* `ArchName <#ArchName>`_ 
* `Architecture <#Architecture>`_ 
* `Endianness <#Endianness>`_ 
* `EndiannessName <#EndiannessName>`_ 
* `OSMajorVersion <#OSMajorVersion>`_ 
* `OSMinorVersion <#OSMinorVersion>`_ 
* `OperatingSystemFamilyName <#OperatingSystemFamilyName>`_ 
* `OperatingSystemId <#OperatingSystemId>`_ 
* `OperatingSystemIdName <#OperatingSystemIdName>`_ 
* `PortId <#PortId>`_ 
* `PortIdName <#PortIdName>`_ 
* `PortIdShortName <#PortIdShortName>`_ 
* `ToolkitMajorVersion <#ToolkitMajorVersion>`_ 
* `ToolkitMinorVersion <#ToolkitMinorVersion>`_ 

Class API
=========

Methods
^^^^^^^


.. method:: __init__()

   `No docstrings available for this method.` 

--------


.. method:: CheckOSVersion(major, minor)

   Returns ``True`` if the OS version is at least `major.minor`.

   **Parameters:**

   * `major` (int)
   * `minor` (int)

   |

   **Returns:**

   `bool` 

--------

.. method:: CheckToolkitVersion(major, minor)

   Returns ``True`` if the toolkit version is at least `major.minor`.

   **Parameters:**

   * `major` (int)
   * `minor` (int)

   |

   **Returns:**

   `bool` 

--------

.. method:: GetArchName()

   Returns the name for the architecture of this `wx.PlatformInformation` instance.

   |

   **Returns:**

   `string` 

--------


.. method:: GetArchitecture()

   Returns the architecture ID of this `wx.PlatformInformation` instance.

   |

   **Returns:**

   `int` 

--------


.. method:: GetEndianness()

   Returns the endianness ID of this `wx.PlatformInformation` instance.

   |

   **Returns:**

   `int` 

--------


.. method:: GetEndiannessName()

   Returns the endianness name of this `wx.PlatformInformation` instance.

   |

   **Returns:**

   `string` 

--------


.. method:: GetOSMajorVersion()

   Returns the run-time major version of the OS associated with this `wx.PlatformInformation` instance.

   See `wx.GetOSVersion <../wxFunctions.html#GetOSVersion>`_ for more info.

   |

   **Returns:**

   `int` 


.. seealso:: `CheckOSVersion`_

--------


.. method:: GetOSMinorVersion()

   Returns the run-time minor version of the OS associated with this `wx.PlatformInformation` instance.

   See `wx.GetOSVersion <../wxFunctions.html#GetOSVersion>`_ for more info.

   |

   **Returns:**

   `int` 


.. seealso:: `CheckOSVersion`_

--------


.. method:: GetOperatingSystemFamilyName()

   Returns the operating system family name of the OS associated with this `wx.PlatformInformation` instance.

   |

   **Returns:**

   `string` 

--------


.. method:: GetOperatingSystemId()

   Returns the operating system ID of this `wx.PlatformInformation` instance.

   |

   **Returns:**

   `int` 

--------


.. method:: GetOperatingSystemIdName()

   Returns the operating system ID name of this `wx.PlatformInformation` instance.

   |

   **Returns:**

   `string` 

--------


.. method:: GetPortId()

   Returns the wxWidgets port ID of this `wx.PlatformInformation` instance.

   |

   **Returns:**

   `int` 

--------


.. method:: GetPortIdName()

   Returns the wxWidgets port ID name of this `wx.PlatformInformation` instance.

   |

   **Returns:**

   `string` 

--------


.. method:: GetPortIdShortName()

   Returns the wxWidgets port ID short name of this `wx.PlatformInformation` instance.

   |

   **Returns:**

   `string` 

--------


.. method:: GetToolkitMajorVersion()

   Returns the run-time major version of the toolkit associated with this `wx.PlatformInformation` instance. 

   |

   **Returns:**

   `int` 


.. note:: Note that if `GetPortId <#GetPortId>`_ returns ``wx.PORT_BASE``, then this value is zero (unless externally modified with `SetToolkitVersion <#SetToolkitVersion>`_); 
   that is, no native toolkit is in use.

--------


.. method:: GetToolkitMinorVersion()

   Returns the run-time minor version of the toolkit associated with this `wx.PlatformInformation` instance. 

   |

   **Returns:**

   `int` 


.. note:: Note that if `GetPortId <#GetPortId>`_ returns ``wx.PORT_BASE``, then this value is zero (unless externally modified with `SetToolkitVersion <#SetToolkitVersion>`_); 
   that is, no native toolkit is in use.

--------


.. method:: IsOk()

   Returns ``True`` if the instance is fully initialized with valid values.

   |

   **Returns:**

   `bool` 

--------


.. method:: IsUsingUniversalWidgets()

   Returns ``True`` if the instance describes a `wxUniversal` build.

   |

   **Returns:**

   `bool` 

--------


.. method:: SetArchitecture(n)

   Sets the architecture enum value associated with this `wx.PlatformInformation` instance. 

   **Parameters:**

   * `n` (int)


--------

.. method:: SetEndianness(n)

   Sets the endiannes enum value associated with this `wx.PlatformInformation` instance. 


   **Parameters:**

   * `n` (int)


--------

.. method:: SetOSVersion(major, minor)

   Sets the version of the operating system associated with this `wx.PlatformInformation` instance. 

   **Parameters:**

   * `major` (int)
   * `minor` (int)


--------

.. method:: SetOperatingSystemId(n)

   Sets the the operating system associated with this `wx.PlatformInformation` instance. 

   **Parameters:**

   * `n` (int)


--------

.. method:: SetPortId(n)

   Sets the wxWidgets port ID associated with this `wx.PlatformInformation` instance. 

   **Parameters:**

   * `n` (int)


--------

.. method:: SetToolkitVersion(major, minor)

   Sets the version of wxWidgets associated with this `wx.PlatformInformation` instance. 

   **Parameters:**

   * `major` (int)
   * `minor` (int)


--------

Properties
^^^^^^^^^^


.. attribute:: ArchName

   See `GetArchName <#GetArchName>`_

.. attribute:: Architecture

   See `GetArchitecture <#GetArchitecture>`_ and `SetArchitecture <#SetArchitecture>`_

.. attribute:: Endianness

   See `GetEndianness <#GetEndianness>`_ and `SetEndianness <#SetEndianness>`_

.. attribute:: EndiannessName

   See `GetEndiannessName <#GetEndiannessName>`_

.. attribute:: OSMajorVersion

   See `GetOSMajorVersion <#GetOSMajorVersion>`_

.. attribute:: OSMinorVersion

   See `GetOSMinorVersion <#GetOSMinorVersion>`_

.. attribute:: OperatingSystemFamilyName

   See `GetOperatingSystemFamilyName <#GetOperatingSystemFamilyName>`_

.. attribute:: OperatingSystemId

   See `GetOperatingSystemId <#GetOperatingSystemId>`_ and `SetOperatingSystemId <#SetOperatingSystemId>`_

.. attribute:: OperatingSystemIdName

   See `GetOperatingSystemIdName <#GetOperatingSystemIdName>`_

.. attribute:: PortId

   See `GetPortId <#GetPortId>`_ and `SetPortId <#SetPortId>`_

.. attribute:: PortIdName

   See `GetPortIdName <#GetPortIdName>`_

.. attribute:: PortIdShortName

   See `GetPortIdShortName <#GetPortIdShortName>`_

.. attribute:: ToolkitMajorVersion

   See `GetToolkitMajorVersion <#GetToolkitMajorVersion>`_

.. attribute:: ToolkitMinorVersion

   See `GetToolkitMinorVersion <#GetToolkitMinorVersion>`_