297 lines
9.8 KiB
Cython
297 lines
9.8 KiB
Cython
# Copyright (C) 2007-2014 various contributors (see AUTHORS)
|
|
#
|
|
# This file is part of Python-EFL.
|
|
#
|
|
# Python-EFL is free software; you can redistribute it and/or
|
|
# modify it under the terms of the GNU Lesser General Public
|
|
# License as published by the Free Software Foundation; either
|
|
# version 3 of the License, or (at your option) any later version.
|
|
#
|
|
# Python-EFL is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
# Lesser General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU Lesser General Public License
|
|
# along with this Python-EFL. If not, see <http://www.gnu.org/licenses/>.
|
|
#
|
|
|
|
"""
|
|
|
|
.. image:: /images/fileselector-button-preview.png
|
|
|
|
Widget description
|
|
------------------
|
|
|
|
This is a button that, when clicked, creates an Elementary window (or
|
|
inner window) with a :py:class:`~efl.elementary.fileselector.Fileselector`
|
|
within.
|
|
|
|
When a file is chosen, the (inner) window is closed and the button emits
|
|
a signal having the selected file as it's ``event_info``.
|
|
|
|
This widget encapsulates operations on its internal file selector on its
|
|
own API. There is less control over its file selector than that one
|
|
would have instantiating one directly.
|
|
|
|
The following styles are available for this button:
|
|
|
|
- ``default``
|
|
- ``anchor``
|
|
- ``hoversel_vertical``
|
|
- ``hoversel_vertical_entry``
|
|
|
|
This widget emits the following signals, besides the ones sent from
|
|
:py:class:`~efl.elementary.button.Button`:
|
|
|
|
- ``file,chosen`` - the user has selected a path which comes as the
|
|
``event_info`` data
|
|
- ``language,changed`` - the program's language changed
|
|
|
|
Default text parts of the fileselector_button widget that you can use for
|
|
are:
|
|
|
|
- ``default`` - Label of the fileselector_button
|
|
|
|
Default content parts of the fileselector_button widget that you can use
|
|
for are:
|
|
|
|
- ``icon`` - Icon of the fileselector_button
|
|
|
|
Fileselector Interface
|
|
======================
|
|
|
|
This widget supports the fileselector interface.
|
|
|
|
If you wish to control the fileselector part using these functions,
|
|
inherit both the widget class and the
|
|
:py:class:`~efl.elementary.fileselector.Fileselector` class
|
|
using multiple inheritance, for example::
|
|
|
|
class CustomFileselectorButton(Fileselector, FileselectorButton):
|
|
def __init__(self, canvas, *args, **kwargs):
|
|
FileselectorButton.__init__(self, canvas)
|
|
|
|
"""
|
|
|
|
from cpython cimport PyUnicode_AsUTF8String
|
|
from libc.stdint cimport uintptr_t
|
|
|
|
from efl.eo cimport _object_mapping_register
|
|
from efl.utils.conversions cimport _ctouni
|
|
from efl.evas cimport Object as evasObject
|
|
|
|
from button cimport Button
|
|
|
|
from efl.utils.deprecated cimport DEPRECATED
|
|
from fileselector cimport elm_fileselector_path_set, \
|
|
elm_fileselector_path_get, elm_fileselector_expandable_set, \
|
|
elm_fileselector_expandable_get, elm_fileselector_folder_only_set, \
|
|
elm_fileselector_folder_only_get, elm_fileselector_is_save_set, \
|
|
elm_fileselector_is_save_get
|
|
|
|
def _cb_string_conv(uintptr_t addr):
|
|
cdef const char *s = <const char *>addr
|
|
return _ctouni(s) if s is not NULL else None
|
|
|
|
cdef class FileselectorButton(Button):
|
|
|
|
"""This is the class that actually implements the widget."""
|
|
|
|
def __init__(self, evasObject parent, *args, **kwargs):
|
|
self._set_obj(elm_fileselector_button_add(parent.obj))
|
|
self._set_properties_from_keyword_args(kwargs)
|
|
|
|
property window_title:
|
|
"""The title for a given file selector button widget's window
|
|
|
|
This is the popup window's title, when the file selector pops
|
|
out after a click on the button. Those windows have the default
|
|
(unlocalized) value of ``"Select a file"`` as titles.
|
|
|
|
.. note:: Setting this will only take effect if the file selector
|
|
button widget is **not** under "inwin mode".
|
|
|
|
:type: string
|
|
|
|
"""
|
|
def __get__(self):
|
|
return _ctouni(elm_fileselector_button_window_title_get(self.obj))
|
|
|
|
def __set__(self, title):
|
|
if isinstance(title, unicode): title = PyUnicode_AsUTF8String(title)
|
|
elm_fileselector_button_window_title_set(self.obj,
|
|
<const char *>title if title is not None else NULL)
|
|
|
|
def window_title_set(self, title):
|
|
if isinstance(title, unicode): title = PyUnicode_AsUTF8String(title)
|
|
elm_fileselector_button_window_title_set(self.obj,
|
|
<const char *>title if title is not None else NULL)
|
|
def window_title_get(self):
|
|
return _ctouni(elm_fileselector_button_window_title_get(self.obj))
|
|
|
|
property window_size:
|
|
"""The size of a given file selector button widget's window,
|
|
holding the file selector itself.
|
|
|
|
.. note:: Setting this will only take any effect if the file
|
|
selector button widget is **not** under "inwin mode". The
|
|
default size for the window (when applicable) is 400x400 pixels.
|
|
|
|
:type: tuple of Evas_Coords (int)
|
|
|
|
"""
|
|
def __get__(self):
|
|
cdef Evas_Coord w, h
|
|
elm_fileselector_button_window_size_get(self.obj, &w, &h)
|
|
return (w, h)
|
|
|
|
def __set__(self, value):
|
|
cdef Evas_Coord w, h
|
|
w, h = value
|
|
elm_fileselector_button_window_size_set(self.obj, w, h)
|
|
|
|
def window_size_set(self, width, height):
|
|
elm_fileselector_button_window_size_set(self.obj, width, height)
|
|
def window_size_get(self):
|
|
cdef Evas_Coord w, h
|
|
elm_fileselector_button_window_size_get(self.obj, &w, &h)
|
|
return (w, h)
|
|
|
|
property inwin_mode:
|
|
"""Whether a given file selector button widget's internal file
|
|
selector will raise an Elementary "inner window", instead of a
|
|
dedicated Elementary window. By default, it won't.
|
|
|
|
.. seealso::
|
|
:py:class:`~efl.elementary.innerwindow.InnerWindow` for more
|
|
information on inner windows
|
|
|
|
:type: bool
|
|
|
|
"""
|
|
def __get__(self):
|
|
return bool(elm_fileselector_button_inwin_mode_get(self.obj))
|
|
|
|
def __set__(self, inwin_mode):
|
|
elm_fileselector_button_inwin_mode_set(self.obj, inwin_mode)
|
|
|
|
def inwin_mode_set(self, inwin_mode):
|
|
elm_fileselector_button_inwin_mode_set(self.obj, inwin_mode)
|
|
def inwin_mode_get(self):
|
|
return bool(elm_fileselector_button_inwin_mode_get(self.obj))
|
|
|
|
|
|
property path:
|
|
"""
|
|
|
|
:see: :py:attr:`~efl.elementary.fileselector.Fileselector.path`
|
|
|
|
.. deprecated:: 1.9
|
|
Combine with Fileselector class instead
|
|
|
|
"""
|
|
def __get__(self):
|
|
return self.path_get()
|
|
|
|
def __set__(self, path):
|
|
self.path_set(path)
|
|
|
|
@DEPRECATED("1.9", "Combine with Fileselector class instead")
|
|
def path_set(self, path):
|
|
if isinstance(path, unicode): path = PyUnicode_AsUTF8String(path)
|
|
elm_fileselector_path_set(self.obj,
|
|
<const char *>path if path is not None else NULL)
|
|
@DEPRECATED("1.9", "Combine with Fileselector class instead")
|
|
def path_get(self):
|
|
return _ctouni(elm_fileselector_path_get(self.obj))
|
|
|
|
property expandable:
|
|
"""
|
|
|
|
:see: :py:attr:`~efl.elementary.fileselector.Fileselector.expandable`
|
|
|
|
.. deprecated:: 1.9
|
|
Combine with Fileselector class instead
|
|
|
|
"""
|
|
def __get__(self):
|
|
return self.expandable_get()
|
|
|
|
def __set__(self, expand):
|
|
self.expandable_set(expand)
|
|
|
|
@DEPRECATED("1.9", "Combine with Fileselector class instead")
|
|
def expandable_set(self, expand):
|
|
elm_fileselector_expandable_set(self.obj, expand)
|
|
@DEPRECATED("1.9", "Combine with Fileselector class instead")
|
|
def expandable_get(self):
|
|
return bool(elm_fileselector_expandable_get(self.obj))
|
|
|
|
property folder_only:
|
|
"""
|
|
|
|
:see: :py:attr:`~efl.elementary.fileselector.Fileselector.folder_only`
|
|
|
|
.. deprecated:: 1.9
|
|
Combine with Fileselector class instead
|
|
|
|
"""
|
|
def __get__(self):
|
|
return self.folder_only_get()
|
|
|
|
def __set__(self, folder_only):
|
|
self.folder_only_set(folder_only)
|
|
|
|
@DEPRECATED("1.9", "Combine with Fileselector class instead")
|
|
def folder_only_set(self, folder_only):
|
|
elm_fileselector_folder_only_set(self.obj, folder_only)
|
|
@DEPRECATED("1.9", "Combine with Fileselector class instead")
|
|
def folder_only_get(self):
|
|
return bool(elm_fileselector_folder_only_get(self.obj))
|
|
|
|
property is_save:
|
|
"""
|
|
|
|
:see: :py:attr:`~efl.elementary.fileselector.Fileselector.is_save`
|
|
|
|
.. deprecated:: 1.9
|
|
Combine with Fileselector class instead
|
|
|
|
"""
|
|
def __get__(self):
|
|
return self.is_save_get()
|
|
|
|
def __set__(self, is_save):
|
|
self.is_save_set(is_save)
|
|
|
|
@DEPRECATED("1.9", "Combine with Fileselector class instead")
|
|
def is_save_set(self, is_save):
|
|
elm_fileselector_is_save_set(self.obj, is_save)
|
|
@DEPRECATED("1.9", "Combine with Fileselector class instead")
|
|
def is_save_get(self):
|
|
return bool(elm_fileselector_is_save_get(self.obj))
|
|
|
|
|
|
def callback_file_chosen_add(self, func, *args, **kwargs):
|
|
"""The user has selected a path which comes as the ``event_info``
|
|
data."""
|
|
self._callback_add_full("file,chosen", _cb_string_conv,
|
|
func, *args, **kwargs)
|
|
|
|
def callback_file_chosen_del(self, func):
|
|
self._callback_del_full("file,chosen", _cb_string_conv, func)
|
|
|
|
def callback_language_changed_add(self, func, *args, **kwargs):
|
|
"""The program's language changed.
|
|
|
|
.. versionadded:: 1.8.1
|
|
|
|
"""
|
|
self._callback_add("language,changed", func, *args, **kwargs)
|
|
|
|
def callback_language_changed_del(self, func):
|
|
self._callback_del("language,changed", func)
|
|
|
|
_object_mapping_register("Elm_Fileselector_Button", FileselectorButton)
|