82 lines
1.8 KiB
Python
82 lines
1.8 KiB
Python
'''
|
|
Orientation
|
|
==========
|
|
|
|
The :class:`Orientation` provides access to public methods to set orientation
|
|
of your device.
|
|
|
|
.. note::
|
|
These settings are generally guidelines, the operating
|
|
system may choose to ignore them, or they may be overridden by
|
|
other system components.
|
|
|
|
.. versionadded:: 1.2.4
|
|
|
|
Simple Examples
|
|
---------------
|
|
|
|
To set landscape::
|
|
|
|
>>> from plyer import orientation
|
|
>>> orientation.set_landscape()
|
|
|
|
To set portrait::
|
|
|
|
>>> orientation.set_portrait()
|
|
|
|
To set sensor::
|
|
|
|
>>> orientation.set_sensor()
|
|
|
|
Supported Platforms
|
|
-------------------
|
|
Android
|
|
|
|
'''
|
|
|
|
|
|
class Orientation:
|
|
'''
|
|
Orientation facade.
|
|
'''
|
|
|
|
def set_landscape(self, reverse=False):
|
|
'''
|
|
Rotate the app to a landscape orientation.
|
|
|
|
:param reverse: If True, uses the opposite of the natural
|
|
orientation.
|
|
'''
|
|
self._set_landscape(reverse=reverse)
|
|
|
|
def set_portrait(self, reverse=False):
|
|
'''
|
|
Rotate the app to a portrait orientation.
|
|
|
|
:param reverse: If True, uses the opposite of the natural
|
|
orientation.
|
|
'''
|
|
self._set_portrait(reverse=reverse)
|
|
|
|
def set_sensor(self, mode='any'):
|
|
'''
|
|
Rotate freely following sensor information from the device.
|
|
|
|
:param mode: The rotation mode, should be one of 'any' (rotate
|
|
to any orientation), 'landscape' (choose nearest
|
|
landscape mode) or 'portrait' (choose nearest
|
|
portrait mode). Defaults to 'any'.
|
|
'''
|
|
self._set_sensor(mode=mode)
|
|
|
|
# private
|
|
|
|
def _set_landscape(self, **kwargs):
|
|
raise NotImplementedError()
|
|
|
|
def _set_portrait(self, **kwargs):
|
|
raise NotImplementedError()
|
|
|
|
def _set_sensor(self, **kwargs):
|
|
raise NotImplementedError()
|