From 883cb445c68a2ed9033ad7c46f35ccfbc6f00e12 Mon Sep 17 00:00:00 2001 From: Mike Blumenkrantz Date: Wed, 25 Sep 2019 15:02:52 +0200 Subject: [PATCH] efl_ui/layout: improve docs Summary: add doc notes for these classes Reviewers: segfaultxavi Reviewed By: segfaultxavi Subscribers: cedric, #reviewers, #committers Tags: #efl Differential Revision: https://phab.enlightenment.org/D10155 --- src/lib/elementary/efl_ui_layout.eo | 2 +- src/lib/elementary/efl_ui_layout_base.eo | 14 +++++++++++++- 2 files changed, 14 insertions(+), 2 deletions(-) diff --git a/src/lib/elementary/efl_ui_layout.eo b/src/lib/elementary/efl_ui_layout.eo index 0ebbb4e1cd..f8ff7a9e39 100644 --- a/src/lib/elementary/efl_ui_layout.eo +++ b/src/lib/elementary/efl_ui_layout.eo @@ -2,7 +2,7 @@ import efl_ui; class Efl.Ui.Layout extends Efl.Ui.Layout_Base implements Efl.File { - [[Elementary layout class + [[EFL layout widget class. When loading layouts from a file, use the @Efl.File.key property to specify the group that the data belongs to, in case it's an EET file diff --git a/src/lib/elementary/efl_ui_layout_base.eo b/src/lib/elementary/efl_ui_layout_base.eo index 4f4624744a..aa616c777a 100644 --- a/src/lib/elementary/efl_ui_layout_base.eo +++ b/src/lib/elementary/efl_ui_layout_base.eo @@ -5,7 +5,19 @@ abstract Efl.Ui.Layout_Base extends Efl.Ui.Widget implements Efl.Container, Efl.Layout.Calc, Efl.Layout.Signal, Efl.Layout.Group { - [[Elementary layout abstract + [[EFL layout widget abstract. + + A "layout" in the context of EFL is an object which interfaces with the internal layout engine. + Layouts are created using the EDC language, and any widget which implements this abstract must + have a corresponding theme group to load in order to graphically display anything. + + Theme groups for EFL widgets must be versioned. This means having a "version" $[data.item] key in + the theme group for the widget. If the loaded theme group for a widget has version info which + is lower than the currently-running EFL version, a warning will be printed to notify the user that + new features may be available. If the loaded theme group for a widget has no version info, an + error will be generated. If the loaded theme group for a widget has a version that is newer than + the currently-running EFL version, a critical error will be printed to notify the user that + the theme may not be compatible. @since 1.22 ]]