diff --git a/README.rst b/README.rst index 8498806ba..045fbd1a8 100644 --- a/README.rst +++ b/README.rst @@ -33,4 +33,5 @@ Unique ID (IMEI or SN) X X X X X X Gyroscope X X X Battery X X X X X X Native file chooser X X X +Orientation X X ================================== ============= ============= === ======= === ===== diff --git a/examples/orientation/buildozer.spec b/examples/orientation/buildozer.spec new file mode 100644 index 000000000..b2a401fa2 --- /dev/null +++ b/examples/orientation/buildozer.spec @@ -0,0 +1,176 @@ +[app] + +# (str) Title of your application +title = Plyer orientation test + +# (str) Package name +package.name = plyerorientation + +# (str) Package domain (needed for android/ios packaging) +package.domain = org.test + +# (str) Source code where the main.py live +source.dir = . + +# (list) Source files to include (let empty to include all the files) +source.include_exts = py,png,jpg,kv,atlas + +# (list) Source files to exclude (let empty to not exclude anything) +#source.exclude_exts = spec + +# (list) List of directory to exclude (let empty to not exclude anything) +#source.exclude_dirs = tests, bin + +# (list) List of exclusions using pattern matching +#source.exclude_patterns = license,images/*/*.jpg + +# (str) Application versioning (method 1) +# version.regex = __version__ = '(.*)' +# version.filename = %(source.dir)s/main.py + +# (str) Application versioning (method 2) +version = 0.1 + +# (list) Application requirements +requirements = plyer,kivy + +# (str) Presplash of the application +#presplash.filename = %(source.dir)s/data/presplash.png + +# (str) Icon of the application +#icon.filename = %(source.dir)s/data/icon.png + +# (str) Supported orientation (one of landscape, portrait or all) +orientation = portrait + +# (bool) Indicate if the application should be fullscreen or not +fullscreen = 0 + + +# +# Android specific +# + +# (list) Permissions +#android.permissions = INTERNET + +# (int) Android API to use +# android.api = 18 + +# (int) Minimum API required (8 = Android 2.2 devices) +#android.minapi = 8 + +# (int) Android SDK version to use +#android.sdk = 21 + +# (str) Android NDK version to use +#android.ndk = 9 + +# (bool) Use --private data storage (True) or --dir public storage (False) +#android.private_storage = True + +# (str) Android NDK directory (if empty, it will be automatically downloaded.) +#android.ndk_path = + +# (str) Android SDK directory (if empty, it will be automatically downloaded.) +#android.sdk_path = + +# (str) python-for-android git clone directory (if empty, it will be automatically cloned from github) +#android.p4a_dir = + +# (str) Android entry point, default is ok for Kivy-based app +#android.entrypoint = org.renpy.android.PythonActivity + +# (list) List of Java .jar files to add to the libs so that pyjnius can access +# their classes. Don't add jars that you do not need, since extra jars can slow +# down the build process. Allows wildcards matching, for example: +# OUYA-ODK/libs/*.jar +#android.add_jars = foo.jar,bar.jar,path/to/more/*.jar + +# (list) List of Java files to add to the android project (can be java or a +# directory containing the files) +#android.add_src = + +# (str) python-for-android branch to use, if not master, useful to try +# not yet merged features. +#android.branch = master + +# (str) OUYA Console category. Should be one of GAME or APP +# If you leave this blank, OUYA support will not be enabled +#android.ouya.category = GAME + +# (str) Filename of OUYA Console icon. It must be a 732x412 png image. +#android.ouya.icon.filename = %(source.dir)s/data/ouya_icon.png + +# (str) XML file to include as an intent filters in tag +#android.manifest.intent_filters = + +# (list) Android additionnal libraries to copy into libs/armeabi +#android.add_libs_armeabi = libs/android/*.so + +# (bool) Indicate whether the screen should stay on +# Don't forget to add the WAKE_LOCK permission if you set this to True +#android.wakelock = False + +# (list) Android application meta-data to set (key=value format) +#android.meta_data = + +# (list) Android library project to add (will be added in the +# project.properties automatically.) +#android.library_references = + +# +# iOS specific +# + +# (str) Name of the certificate to use for signing the debug version +# Get a list of available identities: buildozer ios list_identities +#ios.codesign.debug = "iPhone Developer: ()" + +# (str) Name of the certificate to use for signing the release version +#ios.codesign.release = %(ios.codesign.debug)s + + +[buildozer] + +# (int) Log level (0 = error only, 1 = info, 2 = debug (with command output)) +log_level = 2 + + +# ----------------------------------------------------------------------------- +# List as sections +# +# You can define all the "list" as [section:key]. +# Each line will be considered as a option to the list. +# Let's take [app] / source.exclude_patterns. +# Instead of doing: +# +# [app] +# source.exclude_patterns = license,data/audio/*.wav,data/images/original/* +# +# This can be translated into: +# +# [app:source.exclude_patterns] +# license +# data/audio/*.wav +# data/images/original/* +# + + +# ----------------------------------------------------------------------------- +# Profiles +# +# You can extend section / key with a profile +# For example, you want to deploy a demo version of your application without +# HD content. You could first change the title to add "(demo)" in the name +# and extend the excluded directories to remove the HD content. +# +# [app@demo] +# title = My Application (demo) +# +# [app:source.exclude_patterns@demo] +# images/hd/* +# +# Then, invoke the command line with the "demo" profile: +# +# buildozer --profile demo android debug diff --git a/examples/orientation/main.py b/examples/orientation/main.py new file mode 100644 index 000000000..cea6798a8 --- /dev/null +++ b/examples/orientation/main.py @@ -0,0 +1,43 @@ + +from kivy.base import runTouchApp + +from kivy.lang import Builder + +interface = Builder.load_string(''' +#:import orientation plyer.orientation + +: + text_size: self.size + valign: 'middle' + halign: 'center' + +BoxLayout: + orientation: 'horizontal' + GridLayout: + size_hint_x: 2 + cols: 2 + WrapButton: + text: 'portrait' + on_release: orientation.set_portrait() + WrapButton: + text: 'portrait reverse' + on_release: orientation.set_portrait(reverse=True) + WrapButton: + text: 'landscape' + on_release: orientation.set_landscape() + WrapButton: + text: 'landscape reverse' + on_release: orientation.set_landscape(reverse=True) + WrapButton: + text: 'free sensor' + on_release: orientation.set_sensor(mode='any') + Widget: + WrapButton: + text: 'landscape sensor' + on_release: orientation.set_sensor(mode='landscape') + WrapButton: + text: 'portrait sensor' + on_release: orientation.set_sensor(mode='portrait') +''') + +runTouchApp(interface) diff --git a/plyer/__init__.py b/plyer/__init__.py index 55d4ae173..c3994d5b2 100644 --- a/plyer/__init__.py +++ b/plyer/__init__.py @@ -5,66 +5,56 @@ ''' __all__ = ('accelerometer', 'battery', 'camera', 'compass', 'email', - 'filechooser', 'gps', 'gyroscope', 'irblaster', 'notification', - 'sms', 'tts', 'uniqueid', 'vibrator') + 'filechooser', 'gps', 'gyroscope', 'irblaster', 'orientation', + 'notification', 'sms', 'tts', 'uniqueid', 'vibrator') __version__ = '1.2.4-dev' + from plyer import facades from plyer.utils import Proxy #: Accelerometer proxy to :class:`plyer.facades.Accelerometer` -accelerometer = Proxy( - 'accelerometer', facades.Accelerometer) +accelerometer = Proxy('accelerometer', facades.Accelerometer) #: Battery proxy to :class:`plyer.facades.Battery` -battery = Proxy( - 'battery', facades.Battery) +battery = Proxy('battery', facades.Battery) #: Compass proxy to :class:`plyer.facades.Compass` -compass = Proxy( - 'compass', facades.Compass) +compass = Proxy('compass', facades.Compass) #: Camera proxy to :class:`plyer.facades.Camera` -camera = Proxy( - 'camera', facades.Camera) +camera = Proxy('camera', facades.Camera) #: Email proxy to :class:`plyer.facades.Email` -email = Proxy( - 'email', facades.Email) +email = Proxy('email', facades.Email) #: FileChooser proxy to :class:`plyer.facades.FileChooser` -filechooser = Proxy( - 'filechooser', facades.FileChooser) +filechooser = Proxy('filechooser', facades.FileChooser) #: GPS proxy to :class:`plyer.facades.GPS` -gps = Proxy( - 'gps', facades.GPS) +gps = Proxy('gps', facades.GPS) #: Gyroscope proxy to :class:`plyer.facades.Gyroscope` -gyroscope = Proxy( - 'gyroscope', facades.Gyroscope) +gyroscope = Proxy('gyroscope', facades.Gyroscope) #: IrBlaster proxy to :class:`plyer.facades.IrBlaster` -irblaster = Proxy( - 'irblaster', facades.IrBlaster) +irblaster = Proxy('irblaster', facades.IrBlaster) + +#: Orientation proxy to :class:`plyer.facades.Orientation` +orientation = Proxy('orientation', facades.Orientation) #: Notification proxy to :class:`plyer.facades.Notification` -notification = Proxy( - 'notification', facades.Notification) +notification = Proxy('notification', facades.Notification) #: Sms proxy to :class:`plyer.facades.Sms` -sms = Proxy( - 'sms', facades.Sms) +sms = Proxy('sms', facades.Sms) #: TTS proxy to :class:`plyer.facades.TTS` -tts = Proxy( - 'tts', facades.TTS) +tts = Proxy('tts', facades.TTS) #: UniqueID proxy to :class:`plyer.facades.UniqueID` -uniqueid = Proxy( - 'uniqueid', facades.UniqueID) +uniqueid = Proxy('uniqueid', facades.UniqueID) #: Vibrate proxy to :class:`plyer.facades.Vibrator` -vibrator = Proxy( - 'vibrator', facades.Vibrator) +vibrator = Proxy('vibrator', facades.Vibrator) diff --git a/plyer/facades/__init__.py b/plyer/facades/__init__.py index a7defbb03..7135f082a 100644 --- a/plyer/facades/__init__.py +++ b/plyer/facades/__init__.py @@ -7,8 +7,8 @@ ''' __all__ = ('Accelerometer', 'Battery', 'Camera', 'Compass', 'Email', - 'FileChooser', 'GPS', 'Gyroscope', 'IrBlaster', 'Notification', - 'Sms', 'TTS', 'UniqueID', 'Vibrator') + 'FileChooser', 'GPS', 'Gyroscope', 'IrBlaster', 'Orientation', + 'Notification', 'Sms', 'TTS', 'UniqueID', 'Vibrator') from plyer.facades.accelerometer import Accelerometer from plyer.facades.battery import Battery @@ -19,6 +19,7 @@ from plyer.facades.gps import GPS from plyer.facades.gyroscope import Gyroscope from plyer.facades.irblaster import IrBlaster +from plyer.facades.orientation import Orientation from plyer.facades.notification import Notification from plyer.facades.sms import Sms from plyer.facades.tts import TTS diff --git a/plyer/facades/orientation.py b/plyer/facades/orientation.py new file mode 100644 index 000000000..e58e72344 --- /dev/null +++ b/plyer/facades/orientation.py @@ -0,0 +1,45 @@ +class Orientation(object): + '''Orientation facade. + + .. 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 + ''' + + 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_landscape(self, **kwargs): + raise NotImplementedError() + + 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_portrait(self, **kwargs): + raise NotImplementedError() + + 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) + + def _set_sensor(self, **kwargs): + raise NotImplementedError() diff --git a/plyer/platforms/android/orientation.py b/plyer/platforms/android/orientation.py new file mode 100644 index 000000000..e98e34d54 --- /dev/null +++ b/plyer/platforms/android/orientation.py @@ -0,0 +1,43 @@ +from jnius import autoclass, cast +from plyer.platforms.android import activity +from plyer.facades import Orientation + +ActivityInfo = autoclass('android.content.pm.ActivityInfo') + + +class AndroidOrientation(Orientation): + + def _set_landscape(self, **kwargs): + reverse = kwargs.get('reverse') + if reverse: + activity.setRequestedOrientation( + ActivityInfo.SCREEN_ORIENTATION_REVERSE_LANDSCAPE) + else: + activity.setRequestedOrientation( + ActivityInfo.SCREEN_ORIENTATION_LANDSCAPE) + + def _set_portrait(self, **kwargs): + reverse = kwargs.get('reverse') + if reverse: + activity.setRequestedOrientation( + ActivityInfo.SCREEN_ORIENTATION_REVERSE_PORTRAIT) + else: + activity.setRequestedOrientation( + ActivityInfo.SCREEN_ORIENTATION_PORTRAIT) + + def _set_sensor(self, **kwargs): + mode = kwargs.get('mode') + + if mode == 'any': + activity.setRequestedOrientation( + ActivityInfo.SCREEN_ORIENTATION_SENSOR) + elif mode == 'landscape': + activity.setRequestedOrientation( + ActivityInfo.SCREEN_ORIENTATION_SENSOR_LANDSCAPE) + elif mode == 'portrait': + activity.setRequestedOrientation( + ActivityInfo.SCREEN_ORIENTATION_SENSOR_PORTRAIT) + + +def instance(): + return AndroidOrientation()