Documentation: warnings--

This commit is contained in:
Kai Huuhko 2014-06-01 16:35:38 +03:00
parent 4639836d3e
commit 4f702bc04d
6 changed files with 40 additions and 15 deletions

View File

@ -101,11 +101,3 @@ API Reference
filedownload
filemonitor
Inheritance diagram
-------------------
.. inheritance-diagram::
efl.ecore
:parts: 2

View File

@ -3,5 +3,32 @@
:class:`efl.evas.Object` Class
==============================
.. _Evas_Keys:
Key Input Functions
===================
Functions which feed key events to the canvas.
As explained in :ref:`evas_main_intro_not_evas`, Evas is **not** aware of input
systems at all. Then, the user, if using it crudely (evas_new()),
will have to feed it with input events, so that it can react
somehow. If, however, the user creates a canvas by means of the
Ecore_Evas wrapper, it will automatically bind the chosen display
engine's input events to the canvas, for you.
This group presents the functions dealing with the feeding of key
events to the canvas. On most of them, one has to reference a given
key by a name (``keyname`` argument). Those are
**platform dependent** symbolic names for the keys. Sometimes
you'll get the right ``keyname`` by simply using an ASCII
value of the key name, but it won't be like that always.
Typical platforms are Linux frame buffer (Ecore_FB) and X server
(Ecore_X) when using Evas with Ecore and Ecore_Evas. Please refer
to your display engine's documentation when using evas through an
Ecore helper wrapper when you need the ``keyname``'s.
.. autoclass:: efl.evas.Object
:inherited-members:

View File

@ -3,6 +3,8 @@
.. module:: efl.evas
.. _evas_main_intro:
What is Evas?
-------------
@ -27,6 +29,7 @@ wish, thus keeping it small and lean. It has several display
back-ends, letting it display on several display systems, making it
portable for cross-device and cross-platform development.
.. _evas_main_intro_not_evas:
What Evas is not?
-----------------
@ -41,6 +44,7 @@ should be polled from various sources and fed to Evas. Similarly, it will
not create windows or report windows updates to your system, rather just
drawing the pixels and reporting to the user the areas that were changed.
.. _evas_main_work:
How does Evas work?
-------------------

View File

@ -203,7 +203,9 @@ ELM_DAY_LAST = enums.ELM_DAY_LAST
cdef class CalendarMark(object):
"""An item for the Calendar widget.
"""
An item for the Calendar widget.
A mark that will be drawn in the calendar respecting the insertion
time and periodicity. It will emit the type as signal to the widget theme.
@ -235,7 +237,7 @@ cdef class CalendarMark(object):
def __init__(self, evasObject cal, mark_type, mark_time,
Elm_Calendar_Mark_Repeat_Type repeat):
"""
"""Create a new Calendar mark
:param mark_type: A string used to define the type of mark. It will be
emitted to the theme, that should display a related modification on these

View File

@ -661,7 +661,7 @@ cdef class Configuration(object):
property text_classes_list:
"""Get Elementary's list of supported text classes.
:type: list of :ref:`Elm_Text_Class`
:type: list of tuples (name, desc)
"""
def __get__(self):
@ -691,7 +691,7 @@ cdef class Configuration(object):
the default font properties for that class coming from the theme in
use. There is no need to free this list.
:type: list of :ref:`Elm_Font_Overlay`
:type: list of tuples (text_class, font, size)
"""
def __get__(self):
@ -732,7 +732,7 @@ cdef class Configuration(object):
:param font: Font name and style string
:type font: string
:param size: Font size
:type size: :ref:`Evas_Font_Size`
:type size: int
"""
a1 = text_class

View File

@ -102,7 +102,7 @@ Focus direction
.. versionadded:: 1.8.1
.. _Elm_Focus_Move_Policy
.. _Elm_Focus_Move_Policy:
Focus move policy
=================
@ -119,7 +119,7 @@ Focus move policy
.. versionadded:: 1.10
.. _Elm_Focus_Autoscroll_Mode
.. _Elm_Focus_Autoscroll_Mode:
Focus autoscroll mode
=====================