* Get the selected state of color palette item.
*
* @param it The Colorpalette item
- * @return EINA_TRUE if the item is selected, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE if the item is selected, @c EINA_FALSE otherwise.
*
* @since 1.9
* @ingroup Colorselector
* Set the selected state of color palette item
*
* @param it The Colorpalette item
- * @param selected if it's EINA_TRUE, select the item otherwise, unselect the item
+ * @param selected if it's @c EINA_TRUE, select the item otherwise, unselect the item
*
* @since 1.9
* @ingroup Colorselector
* This sets the globally configured vsync flag that asks some backend
* engines to use vsync display if possible.
*
- * @param enabled This should be EINA_TRUE if enabled, or EINA_FALSE if not.
+ * @param enabled This should be @c EINA_TRUE if enabled, or @c EINA_FALSE if
+ * not.
*
* @since 1.11
*/
* has the global system acceleration preference configureation forcibly
* override whatever acceleration preference the application may want.
*
- * @param enabled This should be EINA_TRUE if enabled, or EINA_FALSE if not.
+ * @param enabled This should be @c EINA_TRUE if enabled, or @c EINA_FALSE if
+ * not.
*
* @since 1.11
*/
*
* @param obj an object with cursor already set.
* @return @c EINA_TRUE if the cursor set should be searched on widget's theme,
- * EINA_FALSE otherwise.
+ * @c EINA_FALSE otherwise.
*
* @ingroup Cursors
*/
* @param it The gengrid item
* @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
*
- * This API returns EINA_TRUE for all the items selected in multi-select mode as well.
+ * This API returns @c EINA_TRUE for all the items selected in multi-select mode as well.
*
* @see elm_gengrid_item_selected_set() for more details
*
/**
* @brief Disable size restrictions on an object's tooltip
* @param it The tooltip's anchor object
- * @param disable If EINA_TRUE, size restrictions are disabled
- * @return EINA_FALSE on failure, EINA_TRUE on success
+ * @param disable If @c EINA_TRUE, size restrictions are disabled
+ * @return @c EINA_FALSE on failure, @c EINA_TRUE on success
*
* This function allows a tooltip to expand beyond its parent window's canvas.
* It will instead be limited only by the size of the display.
/**
* @brief Retrieve size restriction state of an object's tooltip
* @param it The tooltip's anchor object
- * @return If EINA_TRUE, size restrictions are disabled
+ * @return If @c EINA_TRUE, size restrictions are disabled
*
* This function returns whether a tooltip is allowed to expand beyond
* its parent window's canvas.
/**
* @brief Disable size restrictions on an object's tooltip
* @param it The tooltip's anchor object
- * @param disable If EINA_TRUE, size restrictions are disabled
- * @return EINA_FALSE on failure, EINA_TRUE on success
+ * @param disable If @c EINA_TRUE, size restrictions are disabled
+ * @return @c EINA_FALSE on failure, @c EINA_TRUE on success
*
* This function allows a tooltip to expand beyond its parent window's canvas.
* It will instead be limited only by the size of the display.
/**
* @brief Retrieve size restriction state of an object's tooltip
* @param it The tooltip's anchor object
- * @return If EINA_TRUE, size restrictions are disabled
+ * @return If @c EINA_TRUE, size restrictions are disabled
*
* This function returns whether a tooltip is allowed to expand beyond
* its parent window's canvas.
*
* @param it The genlist item object
* @param flip The flip mode
- * (EINA_TRUE = on, EINA_FALSE = off)
+ * (@c EINA_TRUE = on, @c EINA_FALSE = off)
*
* This function sets the flip state of a given genlist item.
* Flip mode overrides current item object.
* @param it The genlist item object
*
* This function returns the flip state of a given genlist item.
- * If the parameter is invalid, it returns EINA_FALSE.
+ * If the parameter is invalid, it returns @c EINA_FALSE.
*
* @see elm_genlist_item_flip_set()
*
* Get the widget's mirrored mode.
*
* @param obj The widget.
- * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
+ * @return @c EINA_TRUE if mirrored is set, @c EINA_FALSE otherwise
*
* @ingroup Mirroring
*/
* Set the widget's mirrored mode.
*
* @param obj The widget.
- * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
+ * @param mirrored @c EINA_TRUE to set mirrored mode, @c EINA_FALSE to unset it.
*
* @ingroup Mirroring
*/
* When widget in automatic mode, it follows the system mirrored mode set by
* elm_mirrored_set().
* @param obj The widget.
- * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
+ * @param automatic @c EINA_TRUE for auto mirrored mode. @c EINA_FALSE for
+ * manual.
*
* @ingroup Mirroring
*/
* Request that your elementary application needs Efreet
*
* This initializes the Efreet library when called and if support exists
- * it returns EINA_TRUE, otherwise returns EINA_FALSE. This must be called
+ * it returns @c EINA_TRUE, otherwise returns @c EINA_FALSE. This must be called
* before any efreet calls.
*
- * @return EINA_TRUE if support exists and initialization succeeded.
+ * @return @c EINA_TRUE if support exists and initialization succeeded.
*
* @ingroup Efreet
*/
* Request that your elementary application needs Elm_Systray
*
* This initializes the Elm_Systray when called and, if support exists,
- * returns EINA_TRUE, otherwise returns EINA_FALSE. This must be called
+ * returns @c EINA_TRUE, otherwise returns @c EINA_FALSE. This must be called
* before any elm_systray calls.
*
- * @return EINA_TRUE if support exists and initialization succeeded.
+ * @return @c EINA_TRUE if support exists and initialization succeeded.
*
* @ingroup Elm_Systray
* @since 1.8
* Request that your elementary application needs Elm_Sys_Notify
*
* This initializes the Elm_Sys_Notify when called and if support exists
- * it returns EINA_TRUE, otherwise returns EINA_FALSE. This must be called
+ * it returns @c EINA_TRUE, otherwise returns @c EINA_FALSE. This must be called
* before any elm_sys_notify calls.
*
- * @return EINA_TRUE if support exists and initialization succeeded.
+ * @return @c EINA_TRUE if support exists and initialization succeeded.
*
* @ingroup Elm_Sys_Notify
* @since 1.8
* Request that your elementary application needs e_dbus
*
* This initializes the E_dbus library when called and if support exists
- * it returns EINA_TRUE, otherwise returns EINA_FALSE. This must be called
+ * it returns @c EINA_TRUE, otherwise returns @c EINA_FALSE. This must be called
* before any e_dbus calls.
*
- * @return EINA_TRUE if support exists and initialization succeeded.
+ * @return @c EINA_TRUE if support exists and initialization succeeded.
*
* @deprecated use elm_need_eldbus() for Eldbus (v2) support. Old API is
* deprecated.
* Request that your elementary application needs eldbus
*
* This initializes the eldbus (aka v2) library when called and if
- * support exists it returns EINA_TRUE, otherwise returns
- * EINA_FALSE. This must be called before any eldbus calls.
+ * support exists it returns @c EINA_TRUE, otherwise returns
+ * @c EINA_FALSE. This must be called before any eldbus calls.
*
- * @return EINA_TRUE if support exists and initialization succeeded.
+ * @return @c EINA_TRUE if support exists and initialization succeeded.
*
* @since 1.8.0
*
* Request that your elementary application needs elocation
*
* This initializes the elocation library when called and if
- * support exists it returns EINA_TRUE, otherwise returns
- * EINA_FALSE. This must be called before any elocation usage.
+ * support exists it returns @c EINA_TRUE, otherwise returns
+ * @c EINA_FALSE. This must be called before any elocation usage.
*
- * @return EINA_TRUE if support exists and initialization succeeded.
+ * @return @c EINA_TRUE if support exists and initialization succeeded.
*
* @since 1.8.0
*
* Request that your elementary application needs ethumb
*
* This initializes the Ethumb library when called and if support exists
- * it returns EINA_TRUE, otherwise returns EINA_FALSE.
+ * it returns @c EINA_TRUE, otherwise returns @c EINA_FALSE.
* This must be called before any other function that deals with
* elm_thumb objects or ethumb_client instances.
*
* Request that your elementary application needs web support
*
* This initializes the Ewebkit library when called and if support exists
- * it returns EINA_TRUE, otherwise returns EINA_FALSE.
+ * it returns @c EINA_TRUE, otherwise returns @c EINA_FALSE.
* This must be called before any other function that deals with
* elm_web objects or ewk_view instances.
*
/**
* @brief Disable size restrictions on an object's tooltip
* @param it The tooltip's anchor object
- * @param disable If EINA_TRUE, size restrictions are disabled
- * @return EINA_FALSE on failure, EINA_TRUE on success
+ * @param disable If @c EINA_TRUE, size restrictions are disabled
+ * @return @c EINA_FALSE on failure, @c EINA_TRUE on success
*
* This function allows a tooltip to expand beyond its parent window's canvas.
* It will instead be limited only by the size of the display.
/**
* @brief Retrieve size restriction state of an object's tooltip
* @param it The tooltip's anchor object
- * @return If EINA_TRUE, size restrictions are disabled
+ * @return If @c EINA_TRUE, size restrictions are disabled
*
* This function returns whether a tooltip is allowed to expand beyond
* its parent window's canvas.
*
* The list function may look at filename, may open the file or do
* anything it likes to determine something about the file. Either it
- * filters it out (returns EINA_FALSE) and it is discarded or it
- * returns EINA_TRUE and also provides a "sort id" which is a string
+ * filters it out (returns @c EINA_FALSE) and it is discarded or it
+ * returns @c EINA_TRUE and also provides a "sort id" which is a string
* store uses to figure out sorting. This string could be the filename, or
* some data based on its contents. The strings are sorted alphabetically
* like any normal ASCII strings, with case being important. As this listing
{
int w, h; /**< The desired icon size in addition to the file path returned from the mapping */
Elm_Icon_Lookup_Order lookup_order; /**< The order in which to find the icon */
- Eina_Bool standard_name : 1; /**< Use a standard name to find it (EINA_TRUE) or not */
- Eina_Bool no_scale : 1; /**< EINA_TRUE is you don't want the icon scaled */
- Eina_Bool smooth : 1; /**< EINA_TRUE if icon is to be smooth scaled */
- Eina_Bool scale_up : 1; /**< EINA_TRUE if scaling up is allowed */
- Eina_Bool scale_down : 1; /**< EINA_TRUE if scaling down is allowed */
+ Eina_Bool standard_name : 1; /**< Use a standard name to find it (@c EINA_TRUE) or not */
+ Eina_Bool no_scale : 1; /**< @c EINA_TRUE is you don't want the icon scaled */
+ Eina_Bool smooth : 1; /**< @c EINA_TRUE if icon is to be smooth scaled */
+ Eina_Bool scale_up : 1; /**< @c EINA_TRUE if scaling up is allowed */
+ Eina_Bool scale_down : 1; /**< @c EINA_TRUE if scaling down is allowed */
};
struct _Elm_Store_Item_Mapping_Empty
* Set the function used to deal with listing of items
*
* This function is called per item that is found so it can examine the item
- * and discard it (return EINA_FALSE to discard, or EINA_TRUE to accept), and
- * work out some sorting ID (that may be filename or anything else based on
+ * and discard it (return @c EINA_FALSE to discard, or @c EINA_TRUE to accept),
+ * and work out some sorting ID (that may be filename or anything else based on
* content). This function is always called from a thread.
*
* @param st The store to set the function of
* Enable or disable fetching in a thread for Store
*
* @param st The store to modify
- * @param use_thread EINA_TRUE to use a thread to fetch, EINA_FALSE don't use a thread.
+ * @param use_thread @c EINA_TRUE to use a thread to fetch, @c EINA_FALSE don't
+ * use a thread.
*
* @ingroup Store
*/
* in the store and then never change it again.
*
* @param st The store to modify
- * @param sorted EINA_TRUE if we are to sort, EINA_FALSE if not.
+ * @param sorted @c EINA_TRUE if we are to sort, @c EINA_FALSE if not.
*
* @ingroup Store
*/
* Get the sorted flag as set by elm_store_sorted_set().
*
* @param st The store to query
- * @return EINA_TRUE if sorted, EINA_FALSE if not.
+ * @return @c EINA_TRUE if sorted, @c EINA_FALSE if not.
*
* @ingroup Store
*/
* path is the full path to the file, if searched, and the file exists, or it
* is simply the full path given in the element or a resolved path if
* relative to home. The @p in_search_path boolean pointed to is set to
- * EINA_TRUE if the file was a search-able file and is in the search path,
- * and EINA_FALSE otherwise.
+ * @c EINA_TRUE if the file was a search-able file and is in the search path,
+ * and @c EINA_FALSE otherwise.
*
* @ingroup Theme
*/
/**
* Get the ethumb_client connection state.
*
- * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
- * otherwise.
+ * @return @c EINA_TRUE if the client is connected to the server or @c
+ * EINA_FALSE otherwise.
*/
EAPI Eina_Bool elm_thumb_ethumb_client_connected_get(void);
*
* @param obj The toolbar object
* @param reorder_mode The reorder mode
- * (EINA_TRUE = on, EINA_FALSE = off)
+ * (@c EINA_TRUE = on, @c EINA_FALSE = off)
*
* @ingroup Toolbar
*/
*
* @param obj The toolbar object
* @return The reorder mode
- * (EINA_TRUE = on, EINA_FALSE = off)
+ * (@c EINA_TRUE = on, @c EINA_FALSE = off)
*
* @ingroup Toolbar
*/
*
* @param obj The toolbar object.
* @param transverse_expanded The transverse expansion of the item.
- * (EINA_TRUE = on, EINA_FALSE = off, default = EINA_FALSE)
+ * (@c EINA_TRUE = on, @c EINA_FALSE = off, default = @c EINA_FALSE)
*
* This will expand the transverse length of the item according the transverse length of the toolbar.
* The default is what the transverse length of the item is set according its min value.
*
* @param obj The toolbar object.
* @return The transverse expansion of the item.
- * (EINA_TRUE = on, EINA_FALSE = off, default = EINA_FALSE)
+ * (@c EINA_TRUE = on, @c EINA_FALSE = off, default = @c EINA_FALSE)
*
* @see elm_toolbar_transverse_expand_set() for details.
*
*/
EAPI Eina_Bool elm_toolbar_transverse_expanded_get(const Evas_Object *obj);
-#include "elm_toolbar.eo.legacy.h"
\ No newline at end of file
+#include "elm_toolbar.eo.legacy.h"
* @brief Disable size restrictions on an object's tooltip
*
* @param obj The tooltip's anchor object
- * @param disable If EINA_TRUE, size restrictions are disabled
- * @return EINA_FALSE on failure, EINA_TRUE on success
+ * @param disable If @c EINA_TRUE, size restrictions are disabled
+ * @return @c EINA_FALSE on failure, @c EINA_TRUE on success
*
* This function allows a tooltip to expand beyond its parent window's canvas.
* It will instead be limited only by the size of the display.
* @brief Retrieve size restriction state of an object's tooltip
*
* @param obj The tooltip's anchor object
- * @return If EINA_TRUE, size restrictions are disabled
+ * @return If @c EINA_TRUE, size restrictions are disabled
*
* This function returns whether a tooltip is allowed to expand beyond
* its parent window's canvas.
* @see elm_transit_objects_final_state_keep_set()
*
* @param transit The transit object.
- * @return EINA_TRUE means the states of the objects will be reset.
- * If @p transit is NULL, EINA_FALSE is returned
+ * @return @c EINA_TRUE means the states of the objects will be reset.
+ * If @p transit is NULL, @c EINA_FALSE is returned
*
* @ingroup Transit
*/
/**
* Set the event enabled when transit is operating.
*
- * If @p enabled is EINA_TRUE, the objects of the transit will receive
+ * If @p enabled is @c EINA_TRUE, the objects of the transit will receive
* events from mouse and keyboard during the animation.
* @note When you add an object with elm_transit_object_add(), its state from
* evas_object_freeze_events_get(obj) is saved, and it is applied when the
* @see elm_transit_event_enabled_set()
*
* @param transit The Transit object
- * @return EINA_TRUE, when event is enabled. If @p transit is NULL
- * EINA_FALSE is returned
+ * @return @c EINA_TRUE, when event is enabled. If @p transit is NULL
+ * @c EINA_FALSE is returned
*
* @ingroup Transit
*/
* the repeat with the function elm_transit_repeat_times_set().
*
* @param transit The transit object.
- * @param reverse EINA_TRUE means the auto_reverse is on.
+ * @param reverse @c EINA_TRUE means the auto_reverse is on.
*
* @ingroup Transit
*/
* @see elm_transit_auto_reverse_set()
*
* @param transit The transit object.
- * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
- * EINA_FALSE is returned
+ * @return @c EINA_TRUE means auto reverse is on. If @p transit is NULL
+ * @c EINA_FALSE is returned
*
* @ingroup Transit
*/
* @note @p transit can not be NULL
*
* @param transit The transit object.
- * @return EINA_TRUE means transition is paused. If @p transit is NULL
- * EINA_FALSE is returned
+ * @return @c EINA_TRUE means transition is paused. If @p transit is NULL
+ * @c EINA_FALSE is returned
*
* @ingroup Transit
*/
*
* @param transit Transit object.
* @param axis Flipping Axis(X or Y).
- * @param cw Flipping Direction. EINA_TRUE is clock-wise.
+ * @param cw Flipping Direction. @c EINA_TRUE is clock-wise.
* @return Flip effect context data.
*
* @ingroup Transit
*
* @param transit Transit object.
* @param axis Flipping Axis(X or Y).
- * @param cw Flipping Direction. EINA_TRUE is clock-wise.
+ * @param cw Flipping Direction. @c EINA_TRUE is clock-wise.
* @return Resizeable flip effect context data.
*
* @ingroup Transit
* @li "load,provisional": Started provisional load
* @li "load,started": Loading of a document started
* @li "menubar,visible,get": Queries if the menubar is visible. Event info
- * is a pointer to Eina_Bool where the callback should set EINA_TRUE if
- * the menubar is visible, or EINA_FALSE in case it's not
+ * is a pointer to Eina_Bool where the callback should set @c EINA_TRUE if
+ * the menubar is visible, or @c EINA_FALSE in case it's not
* @li "menubar,visible,set": Informs menubar visibility. Event info is
* an Eina_Bool indicating the visibility
* @li "popup,created": A dropdown widget was activated, requesting its
Eina_Bool multi : 1;
/* this flag is only for multi selection.
- * If this flag is set to EINA_TRUE, it means directory is selected
+ * If this flag is set to @c EINA_TRUE, it means directory is selected
* so that fileselector will clear current selection when user clicked
* another item. */
Eina_Bool dir_selected : 1;
* mode
* enable/disable */
/* this flag means genlist is supposed to be scrolled. if this flag
- * is set to EINA_TRUE, genlist checks whether it's ok to scroll
+ * is set to @c EINA_TRUE, genlist checks whether it's ok to scroll
* genlist now or not. */
Eina_Bool check_scroll : 1;
Eina_Bool pan_changed : 1;
* animation. (show,
* bring in) */
- /* this is set to EINA_TRUE when the item is re-queued. this
+ /* this is set to @c EINA_TRUE when the item is re-queued. this
* happens when the item is un-queued but the rel item is still in
* the queue. this item will be processed later. */
Eina_Bool requeued : 1;