Summary: Previous @since tags have already been removed from eo files.
Test Plan: Everything builds, but stable classes now have Since tags in the docs.
Reviewers: zmike, bu5hm4n
Reviewed By: bu5hm4n
Subscribers: cedric, #reviewers, #committers
Tags: #efl
Differential Revision: https://phab.enlightenment.org/D8446
abstract Efl.App extends Efl.Loop implements Efl.Core.Command_Line
{
- [[Object representing the application itself]]
+ [[Object representing the application itself.
+
+ @since 1.22
+ ]]
data: null;
methods {
@property app_main @class {
struct Efl.Loop_Arguments {
- [[EFL loop arguments data structure]]
+ [[EFL loop arguments data structure
+
+ @since 1.22
+ ]]
argv: const(array<const(stringshare)>); [[Array with loop arguments]]
initialization: bool; [[Set to $true when the program should initialize its internal state. This happen once per process instance.]]
}
It serializes these and allows for
greater responsiveness without the need for threads (or any other concurrency). However
you can provide these if you need to.
+
+ @since 1.22
]]
methods {
iterate {
{
[[An @Efl.Loop_Consumer is a class which requires one of the parents to provide
an @Efl.Loop interface when performing @Efl.Object.provider_find. It will enforce this by
- only allowing parents which provide such an interface or $NULL.]]
+ only allowing parents which provide such an interface or $NULL.
+
+ @since 1.22
+ ]]
eo_prefix: efl_loop;
methods {
@property loop {
"best effort" basis.
The @Efl.Object.event_freeze and @Efl.Object.event_thaw calls are used to pause and unpause the timer.
+
+ @since 1.22
]]
methods {
@property timer_interval {
enum Efl.Task_Priority {
- [[ ]]
+ [[
+ @since 1.22
+ ]]
normal,
background,
low,
}
enum Efl.Task_Flags {
- [[ ]]
+ [[
+ @since 1.22
+ ]]
none = 0,
use_stdin = 1,
use_stdout = 2,
abstract Efl.Task extends Efl.Loop_Consumer
{
- [[ ]]
+ [[
+ @since 1.22
+ ]]
methods {
@property priority {
[[ The priority of this task. ]]
This defines all the APIs supported by legacy "Edje" object, known in EO
API as Efl.Canvas.Layout.
+
+ @since 1.22
]]
event_prefix: efl_layout;
methods {
interface Efl.Layout.Group
{
[[APIs representing static data from a group in an edje file.
+
+ @since 1.22
]]
methods {
@property group_size_min {
Edje signaling interface.
Note: This API must be manually bound in other languages as this uses function
- pointers! This is by design, to keep the API simplhe API simple.
+ pointers! This is by design, to keep the API simple.
If function pointers really become allowed in EO this needs to be altered to
match that.
*/
function EflLayoutSignalCb {
- [[EflLayoutSignalCb function that is called when a specifc pair of signal/emision is triggered]]
+ [[EflLayoutSignalCb function that is called when a specifc pair of signal/emision is triggered
+
+ @since 1.22
+ ]]
params {
@in object: Efl.Layout.Signal; [[The object the callback is being triggered from.]]
@in emission: string; [[The name component of the signal.]]
interface Efl.Layout.Signal
{
[[Layouts asynchronous messaging and signaling interface.
+
+ @since 1.22
]]
methods {
// FIXME: There is no message_handler in EO!
interface Efl.Canvas.Pointer
{
- [[Efl Canvas Pointer interface]]
+ [[Efl Canvas Pointer interface
+
+ @since 1.22
+ ]]
methods {
/* FIXME Efl.Input.Device is not stable yet*/
@property pointer_inside @beta {
interface Efl.Canvas.Scene
{
- [[Interface containing basic canvas-related methods and events.]]
+ [[Interface containing basic canvas-related methods and events.
+
+ @since 1.22
+ ]]
methods {
@property image_max_size {
get {
APIs in this interface deal with containers of multiple sub objects, not
with individual parts.
+
+ @since 1.22
]]
eo_prefix: efl_content;
event_prefix: efl_container;
This is used for the default content part of widgets, as well as for
individual parts through @Efl.Part.
+
+ @since 1.22
]]
methods {
@property content {
import efl_gfx_types;
mixin Efl.File requires Efl.Object {
- [[Efl file interface]]
+ [[Efl file interface
+
+ @since 1.22
+ ]]
methods {
@property mmap {
set {
struct Efl.File_Save_Info
{
- [[Info used to determine various attributes when saving a file.]]
+ [[Info used to determine various attributes when saving a file.
+
+ @since 1.22
+ ]]
quality: uint; [[The quality level (0-100) to save the file with; commonly used when saving image files.]]
compression: uint; [[The compression level (0-100) to save the file with.]]
encoding: string; [[The encoding to use when saving the file.]]
}
interface Efl.File_Save {
- [[Efl file saving interface]]
+ [[Efl file saving interface
+
+ @since 1.22
+ ]]
methods {
save @const {
[[Save the given image object's contents to an (image) file.
mixin Efl.Gfx.Color
{
- [[Efl Gfx Color mixin class]]
+ [[Efl Gfx Color mixin class
+
+ @since 1.22
+ ]]
data: null;
methods {
@property color @pure_virtual {
import eina_types;
interface Efl.Gfx.Entity {
- [[Efl graphics interface]]
+ [[Efl graphics interface
+
+ @since 1.22
+ ]]
eo_prefix: efl_gfx_entity;
methods {
@property position {
interface Efl.Gfx.Hint
{
- [[Efl graphics hint interface]]
+ [[Efl graphics hint interface
+
+ @since 1.22
+ ]]
event_prefix: efl_gfx_entity;
methods {
@property hint_aspect {
interface Efl.Gfx.Stack
{
- [[Efl graphics stack interface]]
+ [[Efl graphics stack interface
+
+ @since 1.22
+ ]]
event_prefix: efl_gfx_entity;
methods {
@property layer {
Calls to @.close() may or may not block, that's not up to this
interface to specify.
+
+ @since 1.22
]]
methods {
and signal if the stream reached an end, with event
"can_read,changed" or property @.can_read to known whenever a read
would have data to return.
+
+ @since 1.22
]]
methods {
interface to specify. The user can check with event
"can_write,changed" or property @.can_write to known whenever a write
could push more data.
+
+ @since 1.22
]]
methods {
func2(part, args)
func3(part, args)
unref(part)
+
+ @since 1.22
]]
methods {
part_get @protected @const {
interface Efl.Screen
{
- [[Efl screen interface]]
+ [[Efl screen interface
+
+ @since 1.22
+ ]]
methods {
@property screen_size_in_pixels {
get {
interface Efl.Text
{
- [[Efl text interface]]
+ [[Efl text interface
+
+ @since 1.22
+ ]]
methods {
@property text {
set {
struct Efl.Ui.Focus.Manager_Logical_End_Detail {
[[Structure holding the focus object with extra information on logical end
+
+ @since 1.22
]]
is_regular_end : bool; [[$true if element is registered as regular element in the @Efl.Ui.Focus.Manager obejct, $false otherwise]]
element : Efl.Ui.Focus.Object; [[The last element of the logical chain in the @Efl.Ui.Focus.Manager]]
The movement is also keeping track of the history of focused elements.
The tree interpretation differentiates between logical and non-logical widgets,
a logical widget cannot receive focus whereas a non-logical one can.
+
+ @since 1.22
]]
methods {
move {
Focusmanagers are ensuring that if they give focus to something, that they are registered in the upper focus manager.
The most upper focus manager does not need to do that, and can implement this interface to indicate that.
+
+ @since 1.22
]]
}
mixin Efl.Ui.Focus.Object
{
[[Functions of focusable objects.
+
+ @since 1.22
]]
methods {
@property focus_geometry {
class Efl.Ui.Layout extends Efl.Ui.Layout_Base implements Efl.File
{
- [[Elementary layout class]]
+ [[Elementary layout class
+
+ @since 1.22
+ ]]
data: null;
implements {
Efl.File.file { get; set; }
Efl.Layout.Calc, Efl.Layout.Signal,
Efl.Layout.Group
{
- [[Elementary layout abstract]]
+ [[Elementary layout abstract
+
+ @since 1.22
+ ]]
eo_prefix: efl_ui_layout;
data: Efl_Ui_Layout_Data;
methods {
};
struct Efl.Ui.Widget_Focus_State {
- [[All relevant fields needed for the current state of focus registration]]
+ [[All relevant fields needed for the current state of focus registration
+ @since 1.22
+ ]]
manager : Efl.Ui.Focus.Manager; [[The manager where the widget is registered in]]
parent : Efl.Ui.Focus.Object; [[The parent the widget is using as logical parent]]
logical : bool; [[$true if this is registered as logical currently]]
Efl.Access.Widget.Action
//
{
- [[Efl UI widget abstract class]]
+ [[Efl UI widget abstract class
+
+ @since 1.22
+ ]]
//eo_prefix: efl_ui_widget;
event_prefix: efl_ui_widget;
data: Efl_Ui_Widget_Data;
mixin Efl.Ui.Widget_Focus_Manager requires Efl.Ui.Widget extends Efl.Ui.Focus.Manager
{
+ [[
+ @since 1.22
+ ]]
methods {
focus_manager_create @protected @pure_virtual {
[[If the widget needs a focus manager, this function will be called.
enum Efl.Ui.Win_Indicator_Mode
{
- [[Defines the type indicator that can be shown]]
+ [[Defines the type indicator that can be shown
+ @since 1.22
+ ]]
off, [[Request to deactivate the indicator]]
bg_opaque, [[The indicator icon is opaque, as is the indicator background.
The content of window is located at the end of the indicator.
7. top | right,
8. bottom | left,
9. bottom | right.
+
+ @since 1.22
]]
move = 1, [[Start moving window]]
Efl.Text, Efl.Config,
Efl.Ui.Widget_Focus_Manager, Efl.Ui.Focus.Manager_Window_Root
{
- [[Efl UI window class]]
+ [[Efl UI window class
+
+ @since 1.22
+ ]]
methods {
@property indicator_mode {
[[In some environments you may have an indicator that
abstract Efl.Class
{
- [[Abstract Efl class]]
+ [[Abstract Efl class
+
+ @since 1.22
+ ]]
data: null;
}
import eina_types;
struct Efl.Event_Description {
- [[This struct holds the description of a specific event.]]
+ [[This struct holds the description of a specific event.
+
+ @since 1.22
+ ]]
name: string; [[name of the event.]]
unfreezable: bool; [[$true if the event cannot be frozen.]]
legacy_is: bool; [[Internal use: $true if a legacy event.]]
specified @Efl.Callback_Priority_Default is to be assumed.
See @Efl.Callback_Priority_Before @Efl.Callback_Priority_Default @Efl.Callback_Priority_After
- ]]
+
+ @since 1.22
+]]
const Efl.Callback_Priority_Before : Efl.Callback_Priority = -100;
[[Slightly more prioritized than default.]]
- Destruction: The object has no parent and it can be destroyed. The
@.destructor method is called, use it to return any resources the object
might have gathered during its life.
- ]]
+
+ @since 1.22
+ ]]
eo_prefix: efl;
methods {
sense that a standard widget may not have any empty slots for content.
However it's still a group of low-level canvas objects (clipper, raw objects,
etc.).
+
+ @since 1.22
]]
data: Evas_Smart_Data;
methods {
Efl.Input.Interface, Efl.Gfx.Hint,
Efl.Gfx.Mapping, Efl.Ui.I18n, Efl.Canvas.Pointer
{
- [[Efl canvas object abstract class]]
+ [[Efl canvas object abstract class
+
+ @since 1.22
+ ]]
data: Evas_Object_Protected_Data;
methods {
@property pointer_mode_by_device @beta {
these can do shading effects on the object, producing 3D effects.
At the moment of writing, maps can only have 4 points (no more, no less).
+
+ @since 1.22
]]
methods {
mapping_has {
class Efl.Input.Focus extends Efl.Object implements Efl.Input.Event
{
- [[Represents a focus event. ]]
+ [[Represents a focus event.
+
+ @since 1.22
+ ]]
methods {
@property object {
[[The focused object]]
interface Efl.Input.State
{
- [[Efl input state interface]]
+ [[Efl input state interface.
+
+ @since 1.22
+ ]]
eo_prefix: efl_input;
methods {
/* FIXME Efl.Input.Device is not stable yet*/