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

elm: Modify document for APIs. 

Retrieve -> Get as the API says.
This is not a critical change but was done due to the consistency.
This commit is contained in:
Daniel Juyung Seo 2014-11-19 19:51:57 +09:00
parent 0d493615ab
commit 4406302421
21 changed files with 53 additions and 53 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
legacy/elementary/src/lib/elm_app.h
View File

@ -186,7 +186,7 @@ EAPI void elm_app_compile_data_dir_set(const char *dir);
EAPI void elm_app_compile_locale_set(const char *dir);
/**
* Retrieve the application formal name, as set by elm_app_name_set().
* Get the application formal name, as set by elm_app_name_set().
*
* @return The application formal name.
*
@ -196,7 +196,7 @@ EAPI void elm_app_compile_locale_set(const char *dir);
EAPI const char *elm_app_name_get(void);
/**
* Retrieve the path to the '.desktop' file, as set by
* Get the path to the '.desktop' file, as set by
* elm_app_desktop_entry_set().
*
* @return The '.desktop' file path.
@ -207,7 +207,7 @@ EAPI const char *elm_app_name_get(void);
EAPI const char *elm_app_desktop_entry_get(void);
/**
* Retrieve the application's run time prefix directory, as set by
* Get the application's run time prefix directory, as set by
* elm_app_info_set() and the way (environment) the application was
* run from.
*
@ -218,7 +218,7 @@ EAPI const char *elm_app_desktop_entry_get(void);
EAPI const char *elm_app_prefix_dir_get(void);
/**
* Retrieve the application's run time binaries prefix directory, as
* Get the application's run time binaries prefix directory, as
* set by elm_app_info_set() and the way (environment) the application
* was run from.
*
@ -230,7 +230,7 @@ EAPI const char *elm_app_prefix_dir_get(void);
EAPI const char *elm_app_bin_dir_get(void);
/**
* Retrieve the application's run time libraries prefix directory, as
* Get the application's run time libraries prefix directory, as
* set by elm_app_info_set() and the way (environment) the application
* was run from.
*
@ -242,7 +242,7 @@ EAPI const char *elm_app_bin_dir_get(void);
EAPI const char *elm_app_lib_dir_get(void);
/**
* Retrieve the application's run time data prefix directory, as
* Get the application's run time data prefix directory, as
* set by elm_app_info_set() and the way (environment) the application
* was run from.
*
@ -254,7 +254,7 @@ EAPI const char *elm_app_lib_dir_get(void);
EAPI const char *elm_app_data_dir_get(void);
/**
* Retrieve the application's run time locale prefix directory, as
* Get the application's run time locale prefix directory, as
* set by elm_app_info_set() and the way (environment) the application
* was run from.
*

2
legacy/elementary/src/lib/elm_box.eo
View File

@ -141,7 +141,7 @@ class Elm_Box (Elm_Widget)
children {
get {
/*@
Retrieve a list of the objects packed into the box
Get a list of the objects packed into the box
Returns a new @c list with a pointer to @c Evas_Object in its nodes.
The order of the list corresponds to the packing order the box uses.

4
legacy/elementary/src/lib/elm_clock.eo
View File

@ -128,7 +128,7 @@ class Elm_Clock (Elm_Layout)
}
get {
/*@
Retrieve whether a given clock widget is under editing mode
Get whether a given clock widget is under editing mode
or under (default) displaying-only mode.
@return @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE otherwise
@ -224,7 +224,7 @@ class Elm_Clock (Elm_Layout)
}
get {
/*@
Retrieve what digits of the given clock widget should be
Get what digits of the given clock widget should be
editable when in edition mode.
@return Bit mask indicating the digits to be editable

2
legacy/elementary/src/lib/elm_cnp.h
View File

@ -219,7 +219,7 @@ EAPI Eina_Bool elm_cnp_selection_set(Evas_Object *obj, Elm_Sel_Type selection,
const void *buf, size_t buflen);
/**
* @brief Retrieve data from a widget that has a selection.
* @brief Get data from a widget that has a selection.
*
* Get the current selection data from a widget.
* The widget input here will usually be elm_entry,

8
legacy/elementary/src/lib/elm_entry.eo
View File

@ -168,7 +168,7 @@ class Elm_Entry (Elm_Layout, Elm_Interface_Scrollable, Evas.Clickable_Interface,
}
get {
/*@
Retrieve the autocapitalization type on the immodule.
Get the autocapitalization type on the immodule.
@return autocapitalization type
@ -488,7 +488,7 @@ class Elm_Entry (Elm_Layout, Elm_Interface_Scrollable, Evas.Clickable_Interface,
}
get {
/*@
Retrieve the attribute to show the input panel automatically.
Get the attribute to show the input panel automatically.
@return EINA_TRUE if input panel will be appeared when the entry is clicked or has a focus, EINA_FALSE otherwise
@ -539,7 +539,7 @@ class Elm_Entry (Elm_Layout, Elm_Interface_Scrollable, Evas.Clickable_Interface,
}
get {
/*@
Retrieves the current position of the cursor in the entry
Get the current position of the cursor in the entry
@return The cursor position
@ -914,7 +914,7 @@ class Elm_Entry (Elm_Layout, Elm_Interface_Scrollable, Evas.Clickable_Interface,
}
text_style_user_peek @const {
/*@
Retrieve the style on the top of user style stack.
Get the style on the top of user style stack.
@return style on the top of user style stack if exist, otherwise NULL.

2
legacy/elementary/src/lib/elm_gengrid_common.h
View File

@ -216,7 +216,7 @@ EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_
EAPI Eina_Bool elm_gengrid_item_tooltip_window_mode_set(Elm_Object_Item *it, Eina_Bool disable);
/**
* @brief Retrieve size restriction state of an object's tooltip
* @brief Get size restriction state of an object's tooltip
* @param it The tooltip's anchor object
* @return If @c EINA_TRUE, size restrictions are disabled
*

2
legacy/elementary/src/lib/elm_genlist_common.h
View File

@ -245,7 +245,7 @@ EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_
EAPI Eina_Bool elm_genlist_item_tooltip_window_mode_set(Elm_Object_Item *it, Eina_Bool disable);
/**
* @brief Retrieve size restriction state of an object's tooltip
* @brief Get size restriction state of an object's tooltip
* @param it The tooltip's anchor object
* @return If @c EINA_TRUE, size restrictions are disabled
*

4
legacy/elementary/src/lib/elm_panes.eo
View File

@ -57,7 +57,7 @@ class Elm_Panes (Elm_Layout)
}
get {
/*@
Retrieve the split direction of a given panes widget.
Get the split direction of a given panes widget.
@return @c EINA_TRUE, if @p obj is set to be @b horizontal,
@c EINA_FALSE if it's @b vertical (and on errors).
@ -87,7 +87,7 @@ class Elm_Panes (Elm_Layout)
}
get {
/*@
Retrieve the resize mode for the panes of a given panes widget.
Get the resize mode for the panes of a given panes widget.
@return @c EINA_TRUE, if @p obj is set to be resizable by user interaction.

12
legacy/elementary/src/lib/elm_prefs.eo
View File

@ -38,7 +38,7 @@ class Elm_Prefs (Elm_Widget, Efl.File)
}
get {
/*@
Retrieve user data for a given prefs widget
Get user data for a given prefs widget
@return A pointer to the user data of a given prefs widget on success.
@c NULL otherwise.
@ -129,7 +129,7 @@ class Elm_Prefs (Elm_Widget, Efl.File)
}
item_value_get @const {
/*@
Retrieve the value of a given prefs widget's item.
Get the value of a given prefs widget's item.
@return @c EINA_TRUE, on success, @c EINA_FALSE otherwise
@ -149,7 +149,7 @@ class Elm_Prefs (Elm_Widget, Efl.File)
}
item_object_get {
/*@
Retrieve the Elementary widget bound to a given prefs widget's
Get the Elementary widget bound to a given prefs widget's
item.
@return A valid widget handle, on success, or @c NULL, otherwise
@ -188,7 +188,7 @@ class Elm_Prefs (Elm_Widget, Efl.File)
}
item_disabled_get @const {
/*@
Retrieve whether the widget bound to a given prefs widget's item is
Get whether the widget bound to a given prefs widget's item is
disabled or not.
@return @c EINA_TRUE, if it is disabled, @c EINA_FALSE
@ -242,7 +242,7 @@ class Elm_Prefs (Elm_Widget, Efl.File)
}
item_editable_get @const {
/*@
Retrieve whether the widget bound to a given prefs widget's item is
Get whether the widget bound to a given prefs widget's item is
editable or not.
@return @c EINA_TRUE, if it is editable, @c EINA_FALSE
@ -295,7 +295,7 @@ class Elm_Prefs (Elm_Widget, Efl.File)
}
item_visible_get @const {
/*@
Retrieve whether the widget bound to a given prefs widget's item is
Get whether the widget bound to a given prefs widget's item is
visible or not.
@return @c EINA_TRUE, if it is visible, @c EINA_FALSE

4
legacy/elementary/src/lib/elm_prefs_data.h
View File

@ -137,7 +137,7 @@ EAPI Eina_Bool elm_prefs_data_version_set(Elm_Prefs_Data *prefs_data,
unsigned int version);
/**
* Retrieve the version field of a given prefs data handle.
* Get the version field of a given prefs data handle.
*
* @param prefs_data A valid prefs data handle
* @return The version of @a prefs_data or -1, on errors.
@ -201,7 +201,7 @@ EAPI Eina_Bool elm_prefs_data_value_set(Elm_Prefs_Data *prefs_data,
const Eina_Value *value);
/**
* Retrieve one value of a given prefs data handle (by key).
* Get one value of a given prefs data handle (by key).
*
* @param prefs_data A valid prefs data handle
* @param path The (unique) name (key) of the given value

2
legacy/elementary/src/lib/elm_prefs_legacy.h
View File

@ -42,7 +42,7 @@ EAPI Eina_Bool elm_prefs_file_set(Eo *obj, const char *file, const char *page);
/**
*
* Retrieve file and page bound to a given prefs widget.
* Get file and page bound to a given prefs widget.
*
* @return @c EINA_TRUE, on success, @c EINA_FALSE otherwise
*

4
legacy/elementary/src/lib/elm_progressbar.eo
View File

@ -151,7 +151,7 @@ class Elm_Progressbar (Elm_Layout)
}
get {
/*@
Retrieve the orientation of a given progress bar widget
Get the orientation of a given progress bar widget
@return @c EINA_TRUE, if @p obj is set to be @b horizontal,
@c EINA_FALSE if it's @b vertical (and on errors)
@ -188,7 +188,7 @@ class Elm_Progressbar (Elm_Layout)
}
get {
/*@
Retrieve the format string set for a given progress bar widget's
Get the format string set for a given progress bar widget's
units label
@return The format set string for @p obj's units label or

14
legacy/elementary/src/lib/elm_removed.h
View File

@ -510,7 +510,7 @@ EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, cons
/**
* Get the markup text set for the anchorblock
*
* Retrieves the text set on the anchorblock, with markup tags included.
* Gets the text set on the anchorblock, with markup tags included.
*
* @param obj The anchorblock object
* @return The markup text set or @c NULL if nothing was set or an error
@ -540,7 +540,7 @@ EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const
/**
* Get the markup text set for the anchorview
*
* Retrieves the text set on the anchorview, with markup tags included.
* Gets the text set on the anchorview, with markup tags included.
*
* @param obj The anchorview object
* @return The markup text set or @c NULL if nothing was set or an error
@ -2941,7 +2941,7 @@ EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *o
EINA_DEPRECATED EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon);
/**
* Retrieve the icon object set for a given progress bar widget
* Get the icon object set for a given progress bar widget
*
* @param obj The progress bar object
* @return The icon object's handle, if @p obj had one set, or @c NULL,
@ -3092,7 +3092,7 @@ EINA_DEPRECATED EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Obj
EINA_DEPRECATED EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj);
/**
* Retrieve the icon object set for a given slider widget.
* Get the icon object set for a given slider widget.
*
* @param obj The slider object.
* @return The icon object's handle, if @p obj had one set, or @c NULL,
@ -3153,7 +3153,7 @@ EINA_DEPRECATED EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Obje
EINA_DEPRECATED EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj);
/**
* Retrieve the end object set for a given slider widget.
* Get the end object set for a given slider widget.
*
* @param obj The slider object.
* @return The end object's handle, if @p obj had one set, or @c NULL,
@ -3752,7 +3752,7 @@ EINA_DEPRECATED EAPI Eina_Bool elm_list_item_disabled_get(con
EINA_DEPRECATED EAPI Eina_Bool elm_list_item_tooltip_window_mode_set(Elm_Object_Item *it, Eina_Bool disable);
/**
* @brief Retrieve size restriction state of an object's tooltip
* @brief Get size restriction state of an object's tooltip
* @param obj The tooltip's anchor object
* @return If EINA_TRUE, size restrictions are disabled
*
@ -6014,7 +6014,7 @@ EINA_DEPRECATED EAPI double elm_clock_interval_get(const Evas_Object
EINA_DEPRECATED EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Edit_Mode digedit);
/**
* Retrieve what digits of the given clock widget should be
* Get what digits of the given clock widget should be
* editable when in edition mode.
*
* @param obj The clock object

2
legacy/elementary/src/lib/elm_scroller_legacy.h
View File

@ -258,7 +258,7 @@ EAPI void elm_scroller_page_relative_get(const Evas_Obj
EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize);
/**
* @brief Retrieve a scroller widget's current page size.
* @brief Get a scroller widget's current page size.
*
* @param obj The scroller object
* @param h_pagesize Where to store its horizontal page size

2
legacy/elementary/src/lib/elm_slider.eo
View File

@ -19,7 +19,7 @@ class Elm_Slider (Elm_Layout, Elm_Interface_Atspi_Value,
}
get {
/*@
Retrieve the orientation of a given slider widget
Get the orientation of a given slider widget
@return @c EINA_TRUE, if @p obj is set to be @b horizontal,
@c EINA_FALSE if it's @b vertical (and on errors).

4
legacy/elementary/src/lib/elm_slideshow.eo
View File

@ -17,7 +17,7 @@ class Elm_Slideshow (Elm_Layout, Elm_Interface_Atspi_Widget_Action)
}
get {
/*@
Retrieve the number of items to cache, on a given slideshow widget,
Get the number of items to cache, on a given slideshow widget,
<b>after the current item</b>
@return The number of items set to be cached after the current one
@ -45,7 +45,7 @@ class Elm_Slideshow (Elm_Layout, Elm_Interface_Atspi_Widget_Action)
}
get {
/*@
Retrieve the number of items to cache, on a given slideshow widget,
Get the number of items to cache, on a given slideshow widget,
<b>before the current item</b>
@return The number of items set to be cached before the current one

16
legacy/elementary/src/lib/elm_systray.eo
View File

@ -8,7 +8,7 @@ class Elm_Systray (Eo.Base)
/*@ Set the id of the Status Notifier Item. */
}
get {
/*@ Retrieve the id of the Status Notifier Item. */
/*@ Get the id of the Status Notifier Item. */
}
values {
const(char)* id;
@ -19,7 +19,7 @@ class Elm_Systray (Eo.Base)
/*@ Set the category of the Status Notifier Item. */
}
get {
/*@ Retrieve the category of the Status Notifier Item. */
/*@ Get the category of the Status Notifier Item. */
}
values {
Elm_Systray_Category cat; /*@ Category */
@ -30,7 +30,7 @@ class Elm_Systray (Eo.Base)
/*@ Set the path to the theme where the icons can be found. Set this value to "" to use the default path. */
}
get {
/*@ Retrieve the path to the icon's theme currently in use. */
/*@ Get the path to the icon's theme currently in use. */
}
values {
const(char)* icon_theme_path;
@ -41,7 +41,7 @@ class Elm_Systray (Eo.Base)
/*@ Set the object path of the D-Bus Menu that is to be show when the Status Notifier Item is activated by the user. */
}
get {
/*@ Retrieve the object path of the D-Bus Menu currently in use. */
/*@ Get the object path of the D-Bus Menu currently in use. */
}
values {
const(Eo)* menu;
@ -52,7 +52,7 @@ class Elm_Systray (Eo.Base)
/*@ Set the name of the attention icon to be used by the Status Notifier Item. */
}
get {
/*@ Retrieve the name of the attention icon used by the Status Notifier Item. */
/*@ Get the name of the attention icon used by the Status Notifier Item. */
}
values {
const(char)* att_icon_name;
@ -63,7 +63,7 @@ class Elm_Systray (Eo.Base)
/*@ Set the status of the Status Notifier Item. */
}
get {
/*@ Retrieve the status of the Status Notifier Item. */
/*@ Get the status of the Status Notifier Item. */
}
values {
Elm_Systray_Status st; /*@ Status */
@ -74,7 +74,7 @@ class Elm_Systray (Eo.Base)
/*@ Set the name of the icon to be used by the Status Notifier Item. */
}
get {
/*@ Retrieve the name of the icon used by the Status Notifier Item. */
/*@ Get the name of the icon used by the Status Notifier Item. */
}
values {
const(char)* icon_name;
@ -85,7 +85,7 @@ class Elm_Systray (Eo.Base)
/*@ Set the title of the Status Notifier Item. */
}
get {
/*@ Retrieve the title of the Status Notifier Item. */
/*@ Get the title of the Status Notifier Item. */
}
values {
const(char)* title;

2
legacy/elementary/src/lib/elm_tooltip.h
View File

@ -231,7 +231,7 @@ EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj);
EAPI Eina_Bool elm_object_tooltip_window_mode_set(Evas_Object *obj, Eina_Bool disable);
/**
* @brief Retrieve size restriction state of an object's tooltip
* @brief Get size restriction state of an object's tooltip
*
* @param obj The tooltip's anchor object
* @return If @c EINA_TRUE, size restrictions are disabled

2
legacy/elementary/src/lib/elm_widget.c
View File

@ -4277,7 +4277,7 @@ _elm_widget_item_del_cb_set(Eo *eo_item EINA_UNUSED,
/**
* @internal
*
* Retrieves owner widget of this item.
* Get owner widget of this item.
*
* @param item a valid #Elm_Widget_Item to get data from.
* @return owner widget of this item.

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

@ -6,7 +6,7 @@ class Elm_Widget_Item(Eo.Base)
tooltip_window_mode {
get {
/**
@brief Retrieve size restriction state of an object's tooltip
@brief Get size restriction state of an object's tooltip
This function returns whether a tooltip is allowed to expand beyond
its parent window's canvas.

2
legacy/elementary/src/lib/elm_win.eo
View File

@ -342,7 +342,7 @@ class Elm_Win (Elm_Widget, Elm_Interface_Atspi_Window,
}
get {
/*@
Retrieve the constraints on the maximum width and height of a window relative to the width and height of its screen
Get the constraints on the maximum width and height of a window relative to the width and height of its screen
When this function returns true, @p obj will never resize larger than the screen.
@return EINA_TRUE to restrict the window's maximum size, EINA_FALSE to disable restriction