docs: Fix problems with monospaced text

Eolian recently added support for $[...] which allows highlighting
more than one word in monospaced text.
This commit is contained in:
Xavi Artigas 2019-10-02 11:31:19 +02:00
parent 8d37815a73
commit f53583a5c9
5 changed files with 25 additions and 27 deletions

View File

@ -5,23 +5,21 @@ class @beta Efl.Text_Markup_Util {
methods {
text_to_markup @static {
[[Converts a given (UTF-8) text to a markup-compatible string.
This is used mainly to set a plain text with the $.markup_set
property.
This is used mainly to set a plain text with @Efl.Text_Markup.markup.set.
]]
params {
@in text: string; [[The text (UTF-8) to convert to markup]]
@in text: string; [[The text (UTF-8) to convert to markup.]]
}
return: mstring @move; [[The markup representation of given text]]
return: mstring @move; [[The markup representation of given text.]]
}
markup_to_text @static {
[[Converts a given (UTF-8) text to a markup-compatible string.
This is used mainly to set a plain text with the $.markup_set
property.
[[Converts a markup string to a (UTF-8) plain text.
This is used mainly to set a markup text with the @Efl.Text.text.set.
]]
params {
@in text: string; [[The markup-text to convert to text (UTF-8)]]
@in text: string; [[The markup-text to convert to text (UTF-8).]]
}
return: mstring @move; [[The text representation of given format]]
return: mstring @move; [[The text representation of given markup string.]]
}
}
}

View File

@ -3,10 +3,10 @@ class @beta Efl.Ui.Average_Model extends Efl.Ui.Exact_Model
[[Class to be used to store object item size for List/Grid View.
This model provide the same feature as @Efl.Ui.Exact_Model except for the
@Efl.Model.property "$total.width" and "$total.height" which reflect an
@Efl.Model.property $["total.width"] and $["total.height"] which reflect an
estimated value of the total size by using the currently know size from its
children as an average size for all its children. As more children fill
"$self.width" and "$self.height", this model will figure out a more precise
$["self.width"] and $["self.height"], this model will figure out a more precise
answer. Once all children size is known, the result will be exact and the same
as @Efl.Ui.Exact_Model.

View File

@ -2,13 +2,13 @@ class @beta Efl.Ui.Exact_Model extends Efl.Ui.Size_Model
{
[[Class to be used to store object item size for List/Grid View.
This model provide "$total.width" and "$total.height" as an accumulated size of all
its children "$self.width" and "$self.height" @Efl.Model.property. This is currently
This model provide $["total.width"] and $["total.height"] as an accumulated size of all
its children $["self.width"] and $["self.height"] @Efl.Model.property. This is currently
assuming a vertical list only.
This model will return an error code EAGAIN for "$item.width" and "$item.height" all
This model will return an error code $EAGAIN for $["item.width"] and $["item.height"] all
the time and the View that use this Model should continue to get this value even after
computing all the "$self.width" and "$self.height" of this object children.]]
computing all the $["self.width"] and $["self.height"] of this object children.]]
implements {
Efl.Object.constructor;

View File

@ -2,16 +2,16 @@ class @beta Efl.Ui.Homogeneous_Model extends Efl.Ui.Size_Model
{
[[Class to be used to store object item size for List/Grid View.
This model provides the properties "$item.width" and "$item.height" which have the
same value for all siblings of this object. The first sibling that defines "$self.width"
and "$self.height" set them for all other siblings and also set "$item.width" and
"$item.height" for the parent (See @Efl.Ui.Size_Model).
This model provides the properties $["item.width"] and $["item.height"] which have the
same value for all siblings of this object. The first sibling that defines $["self.width"]
and $["self.height"] set them for all other siblings and also set $["item.width"] and
$["item.height"] for the parent (See @Efl.Ui.Size_Model).
Subsequent attempts to set "$self.width" or "$self.height" will fail with a
Subsequent attempts to set $["self.width"] or $["self.height"] will fail with a
Read Only error code.
The properties "$total.width" and "$total.height" are computed from the number of node,
the "$self.width" and "$self.height" assuming that the View is a vertical list.]]
The properties $["total.width"] and $["total.height"] are computed from the number of node,
the $["self.width"] and $["self.height"] assuming that the View is a vertical list.]]
implements {
Efl.Object.constructor;

View File

@ -2,14 +2,14 @@ class @beta Efl.Ui.Size_Model extends Efl.Composite_Model
{
[[Class to be used to store object item size for List/Grid View.
This model provide the following properties that can be retrived by
This model provide the following properties that can be retrieved by
@Efl.Model.properties.get :
- "$self.width" and "$self.height" define the size of this object from the point of
view of the @Efl.Ui.View that use it. It only apply on children and not on the
- $["self.width"] and $["self.height"] define the size of this object from the point of
view of the @Efl.Ui.View that use it. They only apply to children and not to the
top root object.
- "$item.width" and "$item.height" define all the children size and is available
- $["item.width"] and $["item.height"] define all the children size and are available
only on @Efl.Ui.Size_Model that do have children.
- "$total.width" and "$total.height" define the accumulated size used by all the children.
- $["total.width"] and $["total.height"] define the accumulated size used by all the children.
Only vertical list accumulation logic is implemented at this point.]]
data: null;