dimmus
/
efl
forked from enlightenment/efl
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

elm_widget_item: fix doc comments

This commit is contained in:
Daniel Kolesa 2015-05-11 15:11:28 +01:00
parent 7abf897ac0
commit e74cd43c7b
1 changed files with 45 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

90
legacy/elementary/src/lib/elm_widget_item.eo
View File

@ -5,7 +5,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
methods {
@property tooltip_window_mode {
get {
/**
/*@
@brief Get size restriction state of an object's tooltip
This function returns whether a tooltip is allowed to expand beyond
@ -14,7 +14,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
*/
}
set {
/**
/*@
@brief Disable size restrictions on an object's tooltip
This function allows a tooltip to expand beyond its parent window's canvas.
@ -28,7 +28,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
}
@property tooltip_style {
get {
/**
/*@
Get the style for this item tooltip.
@see elm_object_tooltip_style_get() for more details.
@ -38,7 +38,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
*/
}
set {
/**
/*@
Sets a different style for this item tooltip.
@note before you set a style you should define a tooltip with
@ -56,7 +56,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
}
@property cursor {
get {
/*
/*@
Get the type of mouse pointer/cursor decoration set to be shown,
when the mouse pointer is over the given item
@ -68,7 +68,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
*/
}
set {
/**
/*@
Set the type of mouse pointer/cursor decoration to be shown,
when the mouse pointer is over the given item
@ -94,7 +94,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
}
@property cursor_style {
get {
/**
/*@
Get the current @b style set for a given item's custom
cursor
@ -104,7 +104,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
*/
}
set {
/**
/*@
Set a different @b style for a given custom cursor set for an
item.
@ -130,7 +130,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
}
@property cursor_engine_only {
get {
/**
/*@
Get if the (custom) cursor for a given item is being
searched in its theme, also, or is only relying on the rendering
engine.
@ -145,7 +145,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
*/
}
set {
/**
/*@
Set if the (custom)cursor for a given item should be
searched in its theme, also, or should only rely on the
rendering engine.
@ -160,14 +160,14 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
*/
}
values {
bool engine_only; /* Use @c EINA_TRUE to have cursors looked for only
bool engine_only; /*@ Use @c EINA_TRUE to have cursors looked for only
on those provided by the rendering engine, @c EINA_FALSE
to have them searched on the widget's theme, as well. */
}
}
@property part_content {
get {
/**
/*@
Get a content of an object item
@return content of the object item or NULL for any error
@ -178,7 +178,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
*/
}
set {
/**
/*@
Set a content of an object item
This sets a new object to an item as a content object. If any object was
@ -199,7 +199,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
}
@property part_text {
get {
/**
/*@
Get a label of an object item
@note Elementary object items may have many labels
@ -208,7 +208,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
*/
}
set {
/**
/*@
Set a label of an object item
@note Elementary object items may have many labels
@ -241,7 +241,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
}
@property focus {
get {
/**
/*@
Get whether the @p it is focused or not.
@see elm_object_item_focus_set()
@ -251,7 +251,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
*/
}
set {
/**
/*@
Set the object item focused
@see elm_object_item_focus_get()
@ -266,7 +266,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
}
@property style {
get {
/**
/*@
Get the style of an object item
@since 1.9
@ -275,7 +275,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
*/
}
set {
/**
/*@
Set a style of an object item
@since 1.9
@ -289,7 +289,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
}
@property disabled {
get {
/**
/*@
Get the disabled state of an widget item.
This gets the state of the widget, which might be enabled or disabled.
@ -298,7 +298,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
*/
}
set {
/**
/*@
Set the disabled state of an widget item.
Elementary object item can be @b disabled, in which state they won't
@ -318,7 +318,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
}
}
access_order_get {
/**
/*@
@brief Get highlight order
@since 1.8
@ -327,7 +327,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
return: const(list<Evas_Object *>) *;
}
access_order_set {
/**
/*@
@brief Set highlight order
@since 1.8
@ -338,7 +338,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
}
}
widget_get @const {
/**
/*@
Get the widget object's handle which contains a given item
@note This returns the widget object itself that an item belongs to.
@ -348,7 +348,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
return: Evas_Object*; /*@ The widget object */
}
del {
/**
/*@
Delete the given item.
@ingroup General
@ -359,7 +359,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
legacy: null;
}
tooltip_text_set {
/**
/*@
Set the text to be shown in a given object item's tooltips.
Setup the text as tooltip to object. The item can have only one tooltip,
@ -382,7 +382,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
}
}
tooltip_unset {
/**
/*@
Unset tooltip from item.
Remove tooltip from item. The callback provided as del_cb to
@ -396,7 +396,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
*/
}
cursor_unset {
/**
/*@
Unset any custom mouse pointer/cursor decoration set to be
shown, when the mouse pointer is over the given
item, thus making it show the @b default cursor again.
@ -411,7 +411,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
*/
}
part_content_unset {
/**
/*@
Unset a content of an object item
@note Elementary object items may have many contents
@ -428,7 +428,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
legacy: null;
}
signal_callback_add {
/**
/*@
Add a callback for a signal emitted by object item edje.
This function connects a callback function to a signal emitted by the
@ -447,7 +447,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
}
}
signal_callback_del {
/**
/*@
Remove a signal-triggered callback from a object item edje object.
This function removes the @b last callback, previously attached to
@ -470,7 +470,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
return: void*; /*@ The data pointer of the signal callback or @c NULL, on errors. */
}
signal_emit {
/**
/*@
Send a signal to the edje object of the widget item.
This function sends a signal to the edje object of the obj item. An
@ -485,7 +485,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
}
}
access_info_set {
/**
/*@
Set the text to read out when in accessibility mode
@ingroup General
@ -495,7 +495,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
}
}
access_object_get @const {
/**
/*@
@brief Get an accessible object of the object item.
@since 1.8
@ -504,7 +504,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
return: Evas_Object*; /*@ Accessible object of the object item or NULL for any error */
}
domain_translatable_part_text_set {
/**
/*@
Set the text for an object item's part, marking it as translatable.
The string to set as @p text must be the original one. Do not pass the
@ -529,7 +529,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
}
}
translatable_part_text_get @const {
/**
/*@
Get the original string set as translatable for an object item.
When setting translated strings, the function elm_object_item_part_text_get()
@ -549,7 +549,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
legacy: null;
}
domain_part_text_translatable_set {
/**
/*@
Mark the part text to be translatable or not.
Once you mark the part text to be translatable, the text will be translated
@ -573,7 +573,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
}
}
track {
/**
/*@
This returns track object of the item.
@note This gets a rectangle object that represents the object item's internal
@ -604,7 +604,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
return: Evas_Object*; /*@ The track object */
}
untrack {
/**
/*@
This retrieve the track object of the item.
@note This retrieves the track object that was returned from
@ -619,7 +619,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
*/
}
track_get @const {
/**
/*@
Get the track object reference count.
@note This gets the reference count for the track object. Whenever you call
@ -644,7 +644,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
legacy: null;
}
del_cb_set {
/**
/*@
@brief Set the function to be called when an item from the widget is
freed.
@ -663,7 +663,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
}
}
tooltip_content_cb_set {
/**
/*@
Set the content to be shown in the tooltip item.
Setup the tooltip to item. The item can have only one tooltip,
@ -688,7 +688,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
}
}
access_register {
/**
/*@
@brief Register object item as an accessible object.
@since 1.8
@ -697,7 +697,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
return: Evas_Object*; /*@ Accessible object of the object item or NULL for any error */
}
access_unregister {
/**
/*@
@brief Unregister accessible object of the object item.
@since 1.8
@ -705,7 +705,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible)
*/
}
access_order_unset {
/**
/*@
@brief Unset highlight order
@since 1.8