* Signal children add/remove added for box widget
+2013-09-26 Patryk Kaczmarek
+
+ * Function description fixes
+
------------------------------------------------------------------------------
COMPILING AND INSTALLING:
+ autoreconf -vi
./autogen.sh
(optionally use ./configure --with-elementary-modules=/usr/local/lib/elementary/modules/eail/linux-gnu-i686-1.7.99/ )
./configure
------------------------------------------------------------------------------
TESTING
+ autoreconf -vi
./autogen.sh
(optionally use ./configure --with-elementary-modules=/usr/local/lib/elementary/modules/eail/linux-gnu-i686-1.7.99/ )
./configure
/**
* @file eail.c
- * @brief Eail initialization part
+ * @brief EAIL initialization
*/
#include <Elementary.h>
struct _EailUtilListenerInfo
{
gint key; /**< @brief key of entry */
- guint signal_id;/**< @brief id of signal to listen on */
+ guint signal_id;/**< @brief id of the signal */
gulong hook_id;/**< @brief emit hook value returned on signal registration*/
};
struct _EailKeyEventInfo
{
AtkKeyEventStruct *key_event;/**< @brief key of event */
- gpointer func_data;/**< @brief additional data passed to gobject event */
+ gpointer func_data;/**< @brief additional data passed to the event */
};
-/** @brief Cache of objects used to listen and propagate signals */
+/** @brief Cache of objects used for listening and propagating signals */
static GHashTable *listener_list = NULL;
/** @brief Last added id of a listener */
static gint listener_idx = 1;
/**
- * @brief Domain index that will be used as the DOMAIN parameter on EINA log macros.
+ * @brief Domain index that will be used as the DOMAIN parameter on EINA log macros
*
* A negative value means a log occurred.
*/
int _eail_log_dom = -1;
/**
- * @brief This is used to track last focused atk object
+ * @brief A variable for tracking the last focused AtkObject
*/
static AtkObject *eail_atk_last_focused_obj = NULL;
/**
- * @brief Gets toolkit name
- * @return toolkit name
+ * @brief Gets the name of the toolkit
+ * @return string representing the name of the toolkit
*/
static const gchar * eail_get_toolkit_name(void)
{
}
/**
- * @brief Gets toolkit version
+ * @brief Gets the version of the toolkit
*
- * @return toolkit version
+ * @return string representing the version of the toolkit
*/
static const gchar * eail_get_toolkit_version(void)
{
}
/**
- * @brief Gets the root accessible container for the current application
+ * @brief Gets the accessible root container for the current application
*
- * @return root Accessible container
+ * @return AtkObject representing the accessible root container
*/
static AtkObject * eail_get_root(void)
{
/**
* @brief Callback to be called when an object receives focus
*
- * @param current_focused_obj an AtkObject
+ * @param current_focused_obj AtkObject instance
*/
static void
eail_focus_listener_cb(AtkObject *current_focused_obj)
g_object_ref(current_focused_obj);
- /* already notyfying about focus in widget implementation so do not need
+ /* already notifying about focus in widget implementation so do not need
* to notify here for new focus*/
eail_atk_last_focused_obj = current_focused_obj;
}
}
/**
- * @brief Creates and adds listener for given object type
- * @param listener - GObject Emission Hook (a simple function pointer to get
+ * @brief Creates and adds a listener for the given object type
+ *
+ * @param listener GObject Emission Hook (a simple function pointer to get
* invoked when the signal is emitted)
- * @param object_type string name of object type
- * @param signal string name of signal to listen
+ * @param object_type name string representing object's type
+ * @param signal name string representing the signal to listen
* @param hook_data GObject 'hook' info
*
- * @returns id of a newly added listener
+ * @returns integer representing the id of the newly added listener
*/
static guint
add_listener (GSignalEmissionHook listener,
}
/**
- * @brief Removes listener for given object type
+ * @brief Removes a listener for given object type
*
- * @param remove_listener id of listener to remove
+ * @param remove_listener id of the listener to remove
*/
static void
eail_remove_global_event_listener (guint remove_listener)
}
/**
- * @brief initialization for global event listener
+ * @brief Initialization for global event listener
*
- * @param listener an GSignalEmissionHook (GObject 'signal invocation hint')
- * @param event_type string representation of event type
+ * @param listener GSignalEmissionHook (GObject 'signal invocation hint')
+ * @param event_type string representing the event's type
*
- * @return id of added listener
+ * @return integer representing the id of the added listener
*/
static guint
eail_add_global_event_listener(GSignalEmissionHook listener,
}
/**
- * @brief destructor for listener info object
+ * @brief Destructor for listener info object
*
* @param data data to be freed
*/
* @brief Function to be executed by Elementary when EAIL module is loaded
*
* @param m Elm_Module data
- * @return 1 on success, otherwise 0
+ * @return 1 on success, 0 otherwise
*/
int
elm_modapi_init(void *m)
/**
* @brief Function to be executed by Elementary when EAIL module is unloaded
*
- * @param m Elm_Module
- * @return always 1' - notifying success
+ * @param m Elm_Module data
+ * @return always 1 - notifying success
*/
int
elm_modapi_shutdown(void *m)
* @mainpage Manual SDK
*
* @section Description
- * EAIL (Enlightenment Accessibility Implementation Library) is implementation
+ * EAIL (Enlightenment Accessibility Implementation Library) is an implementation
* of ATK (Accessibility Toolkit) - it allows to receive accessible content
* representation for Elementary widgets.
- * EAIL is meant to be a bridge Elementary and ATK, thus various ATs can query for
+ * EAIL is meant to be a bridge between Elementary and ATK, thus various ATs can query for
* accessible information using AT-SPI2.
* ATK is an accessibility toolkit conforming to the Section 508 Standards.
* EAIL is developed as an Elementary module and loaded whenever Elementary
* ./configure --with-elementary-modules=/usr/local/lib/elementary/modules/eail/linux-gnu-x86_64-1.7.99/
* @endcode
* </p>
- * <p>When EAIL module is installed, then Elementary library has to be notified
- * about new module - it needs to load EAIL module during startup.
+ * <p>When EAIL module is installed, Elementary library has to be notified
+ * about the new module - it needs to load EAIL module during startup.
* This can be done using 'ELM_MODULES' environmental variable.</p>
- * <p>Below is a code snippet, that shows how to set EAIL module load for current
+ * <p>Below is a code snippet that shows how to set EAIL module load for the current
* session:
* @code
* export ELM_MODULES="eail>eail/api"
* @endcode
*
* NOTE: ELM_MODULES can also be set for every session using elementary configuration
- * files. Details on how to do that can be found in Elementary documentation.
+ * files. Details on how to do that can be found in the Elementary documentation.
*
- * <p>This is all needed configuration - now elementary application can be
+ * <p>This is all configuration needed - now an elementary application can be
* launched and accessible content for target application should be visible
- * when using accessibility clients (eg. ORCA, TADEK, accerciser...)</p>
+ * when using accessibility clients (eg. ORCA, TADEK, accerciser...).</p>
* </p>
*
* @section Architecture
- * <p>EAIL is implemented as module of Enlightenment (it is located in Elementary
- * modules directory). When elementary-application is being
+ * <p>EAIL is implemented as a module of Enlightenment (it is located in Elementary
+ * modules directory). When an elementary application is being
* launched and ELM_MODULES is set correctly, then EAIL module is also loaded.
* EAIL module registers itself to ATK bridge, so accessibility client
- * application (eg. ORCA, TADEK) can obtain information (in form of accessible
+ * application (eg. ORCA, TADEK) can obtain information (in form of an accessible
* ATK object) about every visible element in application UI.</p>
* <p>
- * See diagram of architecture below:
+ * See the diagram of architecture below:
* @image html eail_component_diagram.png
* </p>
*
* @section Dataflow Data Flow
- * <p>When accessibility client wants to get accessible content of application
- * it needs to get 'root' ATK object for application. To do that, client has to
+ * <p>When an accessibility client wants to get the accessible content of an application
+ * it needs to get the 'root' ATK object for application. To do that, the client has to
* call atk_get_root() on ATK/AT-SPI brigde. Request is propagated to EAIL which
- * creates new instance of EailApp which is ATK representation of elementary
+ * creates a new instance of EailApp which is the ATK representation of the elementary
* application.</p>
* <p>
- * Below is diagram that shows what is happening during that operation:
+ * Below is a diagram that shows what is happening during that operation:
* @image html eail_get_root_flow.png
* </p>
*
- * <p>When accessibility client holds reference to ATK root object (EailApp), it
- * can use AtkObject interface to use objects accessible functionality (eg.
+ * <p>When an accessibility client holds reference to the ATK root object (EailApp), it
+ * can use an AtkObject interface to use the object's accessible functionality (eg.
* get name, set/get description or, the most important one, get reference to
- * children)). To get widget children, client has to call
+ * children)). To get widget's children, client has to call
* <b>atk_object_ref_accessible_child.</b>
* </p>
* <p>
- * Below is diagram that shows how app child (EailWindow) is being created. For
+ * Below is a diagram that shows how an app child (EailWindow) is being created. For
* other kinds of object data flow is very similar:
* @image html eail_ref_window_child_flow.png
* </p>
* -# "property-change"
* <p>
* NOTE: To receive events from EAIL widget, ATK-client application needs to
- * hold reference to target widget (it can be achieved by eg. listing whole
+ * hold reference to the target widget (it can be achieved by eg. listing the whole
* widget hierarchy tree). Without that event listener for widget won't be
* registered and ATK events won't be propagated.
* \n
* To be sure that client always
- * has correct widget tree, it needs to refresh widget descendants every time
+ * has the correct widget tree, it needs to refresh the widget's descendants every time
* it receives "visible-data-changed" event from ATK.
* </p>
- * Example how to register for events using python pyatspi binding (
- * as mentioned above all objects that we're interesed in have to be listed at
- * first, below is a code spippet only for event registration for pyatspi part):
+ * Below is an example on how to register for events using python pyatspi binding (
+ * as mentioned above, all objects that we're interested in have to be listed at
+ * first; below is a code snippet only for event registration for pyatspi part):
* @code
* pyatspi.Registry.registerEventListener(test_cb, "focus")
* pyatspi.Registry.registerEventListener(test_cb, "object:state-changed")
* <p>Below are some examples on how to use C API for ATK with EAIL.
* </p>
* <p>
- * How to get root ATK object for current application:
+ * How to get the root ATK object for the current application:
* @code
* AtkObject *atk_obj = atk_get_root();
* @endcode
* </p>
*
* <p>
- * How to count children of given ATK object:
+ * How to get the children count for given ATK object:
* @code
* gint n = atk_object_get_n_accessible_children(atk_obj);
* @endcode
* </p>
*
* <p>
- * How to obtain reference to first child of ATK object:
+ * How to obtain a reference to the first child of ATK object:
* @code
* AtkObject *atk_obj = atk_object_ref_accessible_child(atk_obj, 0);
* @endcode
* </p>
*
* <p>
- * How to launch first action of given ATK object that supports ATK_ACTION
+ * How to launch the first action of the given ATK object that supports ATK_ACTION
* interface:
* @code
* gboolean success = atk_action_do_action(ATK_ACTION(atk_obj), 0);
* </p>
*
* <p>
- * How to get name of action with given index ('1'):
+ * How to get the name of an action with the given index ('1'):
* @code
* const gchar *action_name = atk_action_get_name(ATK_ACTION(atk_obj), 1);
* @endcode
extern "C" {
#endif
-/** @brief ATK initializer for accessibility API */
EAPI int elm_modapi_init(void *m);
-/** @brief ATK desctructor for accessibility API */
EAPI int elm_modapi_shutdown(void *m);
#ifdef __cplusplus
*/
/**
- * @brief handler for pos_changed event
+ * @brief Handler for pos_changed event
*
- * @param data passed to callback
+ * @param data data passed to callback
* @param obj object that raised event
* @param event_info additional event info
*/
* @brief EailActionSlider object initialization
*
* @param obj EailActionSlider object
- * @param data user set additional initialization data
+ * @param data additional initialization data
*/
static void
eail_action_slider_initialize(AtkObject *obj, gpointer data)
/**
* @brief GObject type initialization function
*
- * @param klass EailActionSlider class
+ * @param klass EailActionSliderClass instance
*/
static void
eail_action_slider_class_init(EailActionSliderClass *klass)
*/
/**
- * @brief Gets obj current value
+ * @brief Gets obj's current value
*
* @param obj EailActionSlider instance
- * @param [out] value EailActionSlider current value
+ * @param [out] value obj's current value
*/
static void
eail_action_slider_get_current_value(AtkValue *obj,
}
/**
- * @brief Gets obj maxiumum value
+ * @brief Gets obj's maxiumum value
*
* @param obj EailActionSlider instance
- * @param [out] value EailActionSlider maxiumum value
+ * @param [out] value obj's maxiumum value
*/
static void
eail_action_slider_get_maximum_value(AtkValue *obj,
}
/**
- * @brief Gets obj minimum value
+ * @brief Gets obj's minimum value
*
* @param obj EailActionSlider instance
- * @param [out] value EailActionSlider minimum value
+ * @param [out] value obj's minimum value
*/
static void
eail_action_slider_get_minimum_value(AtkValue *obj,
}
/**
- * @brief Sets obj value
+ * @brief Sets obj's value
*
* @param obj EailActionSlider instance
- * @param value EailActionSlider new value
- * @return TRUE if new value is set successfully, FALSE otherwise
+ * @param value obj's new value
+ * @return TRUE if new value was set successfully, FALSE otherwise
*/
static gboolean
eail_action_slider_set_current_value(AtkValue *obj,
}
/**
- * @brief Gets obj minimum increment
+ * @brief Gets obj's minimum increment
*
* @param obj EailActionSlider instance
- * @param [out] value EailActionSlider minimum increment
+ * @param [out] value obj's minimum increment
*/
static void
eail_action_slider_get_minimum_increment(AtkValue *obj,
g_value_set_uint(value, ELM_ACTIONSLIDER_NONE);
}
-/**
- * @brief Initialization of AtkValue interface
- *
- * Function called upon instance creation. It initializes AtkValue interface
- * implementation i.e hooks method pointers in the interface structure
- * to the implementing class's implementation.
- *
- * @param iface an AtkObject that implements AtkValueInterface
- */
+
static void
atk_value_interface_init(AtkValueIface *iface)
{
* @brief Macro upcasts an instance (obj) of a subclass to the EailActionSlider
* type
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_ACTION_SLIDER(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), \
EAIL_TYPE_ACTION_SLIDER, EailActionSlider))
/**
* @brief Tests whether object (obj) is an instance of EailActionSlider class
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_IS_ACTION_SLIDER(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), \
EAIL_TYPE_ACTION_SLIDER))
/** @brief Definition of object structure for Atk EailActionSlider*/
struct _EailActionSlider
{
- /** @brief parent object that functionality is being extended*/
+ /** @brief Parent widget whose functionality is being extended*/
EailWidget parent;
};
/**
* @file eail_action_widget.c
- * @brief Implementation of widget that can hold atk actions
+ * @brief EailActionWidget implementation
*/
#include <Elementary.h>
static void atk_action_interface_init(AtkActionIface *iface);
-/** @brief ActionObject structure for objects stored in actions list*/
+/** @brief ActionObject structure for objects stored in actions list */
typedef struct _EailActionObj EailActionObj;
/** @brief ActionObject structure for objects stored in actions list
/**
* @brief Initializer for AtkObjectClass
*
- * @param obj an AtkOject(EailActionWidget) to be initialized
- * @param data additional initialization data (Evas_Object*)
+ * @param obj AtkObject(EailActionWidget) instance to be initialized
+ * @param data additional initialization data
*/
static void
eail_action_widget_initialize(AtkObject *obj, gpointer data)
/**
* @brief Initializer for GObject class
*
- * @param action_widget an AtkOject(EailActionWidget) to be initialized
+ * @param action_widget AtkOject(EailActionWidget) instance to be initialized
*/
static void
eail_action_widget_init(EailActionWidget *action_widget)
/**
* @brief Deallocates memory for EailActionObj
*
- * @param action_obj an EailActionObj( to be freed
+ * @param action_obj EailActionObj instance to be freed
*/
static void
eail_action_obj_free(EailActionObj *action_obj)
}
/**
- * @brief Finalize function for GObject
+ * @brief Finalizes function for GObject
*
- * @param object an GObject(EailActionWidget) to be freed
+ * @param object GObject(EailActionWidget) instance to be freed
*/
static void
eail_action_widget_finalize(GObject *object)
}
/**
- * @brief Init function for GObject
+ * @brief Initiates function for GObject
*
- * @param klass an EailActionWidgetClass to be filled
+ * @param klass EailActionWidgetClass instance to be filled
*/
static void
eail_action_widget_class_init(EailActionWidgetClass *klass)
}
/**
- * @brief Returns number of implemented ATK Actions.
- * Implementation of AtkActionIface get_n_actions callback
+ * @brief Returns the number of implemented ATK actions.
*
- * @param action object that implements AtkAction interface
+ * Implementation of AtkActionIface get_n_actions callback.
*
- * @returns number of actions
+ * @param action AtkAction instance
+ *
+ * @returns integer containing the number of implemented ATK actions
*/
static int
eail_action_widget_n_actions_get(AtkAction *action)
}
/**
- * @brief Returns EailActionObj of action with given index
+ * @brief Returns EailActionObj of an action with the specified index
*
- * @param action object that implements AtkAction interface
+ * @param action AtkAction instance
* @param i index (number) of action
*
- * @returns an EailActionObj* for action with given index
+ * @returns EailActionObj representing the specified action
*/
static EailActionObj *
eail_get_action_obj_i(AtkAction *action,
}
/**
- * @brief Returns EailActionObj of action with given index
+ * @brief Returns EailActionObj of an action with the specified index
*
- * @param action object that implements AtkAction interface
+ * @param action AtkAction instance
* @param i index (number) of action
*
- * @returns string representation of action name
+ * @returns string representing the name of the specified action
*/
static const gchar*
eail_action_widget_action_name_get(AtkAction *action,
}
/**
- * \brief Launches action with given index
+ * @brief Launches the action with the specified index
*
- * @param action object that implements AtkAction interface
+ * @param action AtkAction instance
* @param i index (number) of action
*
* @returns TRUE if action was successfully launched, FALSE otherwise
}
/**
- * \brief Gets description for action with given index
- * Implementation of AtkActionIface get_description callback
+ * @brief Gets the description of an action with the specified index
+ *
+ * Implementation of AtkActionIface get_description callback.
*
- * @param action object that implements AtkAction interface
+ * @param action AtkAction instance
* @param i index (number) of action
*
- * @returns string representing description for action
+ * @returns string representing the description of the specified action
*/
static const gchar*
eail_action_widget_description_get(AtkAction *action,
}
/**
- * \brief Sets description for action with given index
- * Implementation of AtkActionIface set_description callback
+ * @brief Sets description for action with given index
+ *
+ * Implementation of AtkActionIface set_description callback.
*
- * @param action object that implements AtkAction interface
+ * @param action AtkAction instance
* @param i index (number) of action
* @param description description to set
*
- * @returns TRUE if update operation ended with success, FALSE otherwise
+ * @returns TRUE if update operation was successful, FALSE otherwise
*/
static gboolean
eail_action_widget_description_set(AtkAction *action,
* implementation i.e hooks method pointers in the interface structure
* to the implementing class's implementation.
*
- * @param iface interface to be filled
+ * @param iface AtkActionIface instance to be filled
*/
static void
atk_action_interface_init(AtkActionIface *iface)
* @brief Macro upcasts an instance (obj) of a subclass to the EailActionWidget
* type
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_ACTION_WIDGET(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), \
* */
struct _EailActionWidget
{
- EailWidget parent;/*!< widget that is being extended */
-
- Eina_List *action_objs;/*!< list of action objects (EailActionObj*) */
+ /** @brief Parent widget whose functionality is being extended */
+ EailWidget parent;
+ /** @brief List of action objects (EailActionObj*) */
+ Eina_List *action_objs;
};
/** @brief Definition of class structure for Atk EailActionWidget
/**
* @file eail_app.c
- * @brief Implementation of elementary application
+ * @brief Elementary application implementation
*/
#include <Elementary.h>
/**
* @brief Initializer for AtkObjectClass
*
- * @param obj an AtkObject to be initialized
+ * @param obj AtkObject instance to be initialized
* @param data additional initialization data (Evas_Object*)
*/
static void
/**
* @brief Destructor for EailApp object
- * @param obj obj to be freed
+ * @param obj GObject to be freed
*/
static void
eail_app_class_finalize(GObject *obj)
}
/**
- * @brief Implementation AtkObject->get_n_children callback
+ * @brief Gets the number of accessible children of the accessible
*
- * ATK doc says:\n
- * Gets the number of accessible children of the accessible.
+ * Implementation of AtkObject->get_n_children callback.
*
- * @param obj an AtkObject (EailApp)
+ * @param obj AtkObject instance
*
- * @returns an integer representing the number of accessible children of
+ * @returns integer representing the number of accessible children of
* the accessible
*/
static gint
}
/**
- * @brief Implementation AtkObject->ref_child callback
+ * @brief Gets a reference to the specified accessible child of the object.
*
- * ATK doc says:\n
- * Gets a reference to the specified accessible child of the object. The
- * accessible children are 0-based so the first accessible child is at index 0,
+ * The accessible children are 0-based so the first accessible child is at index 0,
* the second at index 1 and so on.
*
- * @param obj an AtkObject (EailApp)
+ * Implementation of AtkObject->ref_child callback.
+ *
+ * @param obj AtkObject instance
* @param i index number
*
- * @returns an AtkObject representing the specified accessible child of the
- * accessible.
+ * @returns AtkObject representing the specified accessible child of the
+ * accessible
*/
static AtkObject *
eail_app_ref_child(AtkObject *obj, gint i)
/**
* @brief Initializer for GObject class
- * @param app an object to be initialized
+ * @param app EailApp instance to be initialized
*/
static void
eail_app_init(EailApp *app)
}
/**
- * @brief Initializer for GObject EailAppClass class (defines callbacks for base
- * AtkObject)
+ * @brief Initializer for GObject EailAppClass class
+ *
+ * Defines callbacks for base AtkObject.
*
- * @param klass an EailAppClass class to be filled
+ * @param klass EailAppClass instance to be filled
*/
static void
eail_app_class_init(EailAppClass *klass)
* @brief Macro upcasts an instance (obj) of a subclass to the EailApp
* type
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_APP(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), \
EAIL_TYPE_APP, EailApp))
/**
* @brief Tests whether object (obj) is an instance of EailApp class
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_IS_APP(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), \
EAIL_TYPE_APP))
/** @brief Definition of object structure for Atk EailBackground*/
struct _EailApp
{
- /** @brief parent AtkObject that functionality is being extended */
+ /** @brief Parent AtkObject whose functionality is being extended */
AtkObject parent;
gint child_count_last;/**< @brief last reported count of children */
};
/**
* @brief EailBackground class initializer
*
- * @param klass an EailBackgroundClass
+ * @param klass EailBackgroundClass instance
*/
static void
eail_background_class_init(EailBackgroundClass *klass)
/**
* @brief EailBackground initializer
*
- * @param obj an AtkObject (EailBackground) to be initialized
- * @param data additional data (Evas_Object*)
+ * @param obj AtkObject (EailBackground) instance to be initialized
+ * @param data additional data
*/
static void
eail_background_initialize(AtkObject *obj, gpointer data)
/**
* @brief EailBackground finalizer
*
- * Destroys object and allocated resources
+ * Destroys the object and allocated resources.
*
- * @param object an EailBackground object to be finalized
+ * @param object EailBackground instance to be finalized
*/
static void
eail_background_finalize(GObject *object)
/**
* @brief EailBackground instance initializer
*
- * @param background an EailBackground
+ * @param background EailBackground instance
*/
static void
eail_background_init(EailBackground *background)
}
/**
- * @brief Gets obj attributes set
+ * @brief Gets obj's attributes set
*
* The caller must unreference it when it is no longer needed.
*
- * @param obj an AtkObject
- * @return attributes set
+ * @param obj AtkObject instance
+ * @return AtkAttributeSet containing obj's attributes
*/
static AtkAttributeSet *
eail_background_get_attributes(AtkObject *obj)
/**
* @brief AtkImage interface initializer
*
- * @param iface an AtkImageIface
+ * @param iface AtkImageIface instance
*/
static void
atk_image_interface_init(AtkImageIface *iface)
}
/**
- * @brief Gets background image position.
+ * @brief Gets background's image position.
*
- * Position is in the form of a point specifying background top-left corner
+ * Position is in the form of a point specifying background top-left corner.
*
- * @param image an AtkImage instance
- * @param [out] x x coordinate
- * @param [out] y y coordinate
- * @param coord_type xy coordinate interpretation
+ * @param image AtkImage instance
+ * @param [out] x x coordinate or -1 if value cannot be obtained
+ * @param [out] y y coordinate or -1 if value cannot be obtained
+ * @param coord_type specifies whether the coordinates are relative to the screen or to the component's top level window
*/
static void
eail_background_get_image_position(AtkImage *image,
}
/**
- * @brief Gets background image description
+ * @brief Gets background image's description
*
- * @param image an AtkImage
- * @return description
+ * @param image AtkImage instance
+ * @return string representing image's description
*/
static const gchar *
eail_background_get_image_description(AtkImage *image)
}
/**
- * @brief Sets background image description
+ * @brief Sets background image's description
*
- * @param image an AtkImage
+ * @param image AtkImage instance
* @param description new image description
- * @return TRUE if description is set successfully, FALSE otherwise
+ * @return TRUE if description was set successfully, FALSE otherwise
*/
static gboolean
eail_background_set_image_description(AtkImage *image,
}
/**
- * @brief Gets background widget size
+ * @brief Gets background's widget size
*
- * @param image an AtkImage
- * @param [out] width background width
- * @param [out] height background height
+ * @param image AtkImage instance
+ * @param [out] width background's width or -1 if value cannot be obtained
+ * @param [out] height background's height or -1 if value cannot be obtained
*/
static void
eail_background_get_image_size(AtkImage *image,
* @brief Macro upcasts an instance (obj) of a subclass to the EailBackground
* type
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_BACKGROUND(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), \
EAIL_TYPE_BACKGROUND, EailBackground))
/**
* @brief Tests whether object (obj) is an instance of EailBackground class
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_IS_BACKGROUND(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), \
EAIL_TYPE_BACKGROUND))
/**
* @brief Gets EailBackground class structure from an obj (class instance)
*
- * @param obj
+ * @param obj object instance to get EailBackground class from
*/
#define EAIL_BACKGROUND_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), \
EAIL_TYPE_BACKGROUND, EailBackgroundClass))
/** @brief Definition of object structure for Atk EailBackground*/
struct _EailBackground
{
- EailWidget parent;/*!< @brief widget that functionality is being extended*/
+ EailWidget parent;/*!< @brief Parent widget whose functionality is being extended*/
- char *description;/*!< @brief background description */
+ char *description;/*!< @brief Background description */
};
/** @brief Definition of class structure for Atk EailBackground*/
/**
* @brief EailBox initializer
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
* @param data initialization data
*/
static void
}
/**
- * @brief Gets widget children
+ * @brief Gets widget's children
*
- * @param widget an EailWidget
- * @return widget children list
+ * @param widget EailWidget instance
+ * @return Eina_List containing widget's children
*/
static Eina_List *
eail_box_get_widget_children(EailWidget *widget)
/**
* @brief EailBox instance initializer
*
- * @param box an EailBox
+ * @param box EailBox instance
*/
static void
eail_box_init(EailBox *box)
/**
* @brief EailBox class initializer
*
- * @param klass an EailBoxClass
+ * @param klass EailBoxClass instance
*/
static void
eail_box_class_init(EailBoxClass *klass)
* @brief Macro upcasts an instance (obj) of a subclass to the EailBox
* type
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_BOX(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), \
EAIL_TYPE_BOX, EailBox))
/**
* @brief Tests whether object (obj) is an instance of EailBox class
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_IS_BOX(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), \
EAIL_TYPE_BOX))
/**
* @brief Gets EailBox class structure from an obj (class instance)
*
- * @param obj obj object instance to get EailBox class from
+ * @param obj object instance to get EailBox class from
*/
#define EAIL_BOX_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), \
EAIL_TYPE_BOX, EailBoxClass))
/** @brief Definition of object structure for Atk EailBox*/
struct _EailBox
{
- /** @brief parent object that functionality is being extended */
+ /** @brief Parent widget whose functionality is being extended */
EailWidget parent;
};
/**
* @file eail_bubble.c
- * @brief Implementation of EailBubble
+ * @brief EailBubble implementation
*/
#include <Elementary.h>
/**
* @brief EailBubble object initialization
*
- * @param obj EailBubble object
+ * @param obj EailBubble instance
* @param data user set additional initialization data
*/
static void
/**
* @brief Class destructor
*
- * @param object object instance
+ * @param object GObject instance
*/
static void
eail_bubble_finalize(GObject *object)
}
/**
- * @brief Gets list of child widget
+ * @brief Gets the list of widget's accessible children
*
- * @param widget EailWidget object
+ * @param widget EailWidget instance
*
- * @return list of child, NULL if no children
+ * @return Eina_List representing the list of accessible children
+ * or NULL if widget has no children
*/
static Eina_List *
eail_bubble_get_widget_children(EailWidget *widget)
/**
* @brief GObject type initialization function
*
- * @param klass EailBubble class
+ * @param klass EailBubbleClass instance
*/
static void
eail_bubble_class_init(EailBubbleClass *klass)
*/
/**
- * @brief Implementation of get_n_actions from AtkAction interface
+ * @brief Gets the number of accessible actions available on the object
+ *
+ * Implementation of get_n_actions from AtkAction interface.
*
* @param action EailBubble instance
*
- * @returns number of actions
+ * @returns integer representing the number of available actions
*/
static int
eail_bubble_n_actions_get(AtkAction *action)
}
/**
- * @brief Implementation of get_description from AtkAction interface
+ * @brief Gets the description string of the specified action
+ *
+ * Implementation of get_description from AtkAction interface.
*
* @param action EailBubble instance
* @param i action index
*
- * @return action description
+ * @return string representing the specified action's description
*/
static const char*
eail_bubble_description_get(AtkAction *action,
}
/**
- * @brief Implementation of set_descritpion from AtkAction interface
+ * @brief Sets a description of the specified action of the object
*
- * @param action EailBubble instance
+ * Implementation of set_description from AtkAction interface.
+ *
+ * @param action AtkAction instance
* @param i action index
* @param description action description
*
}
/**
- * @brief Implementation of get_name from AtkAction interface
+ * @brief Gets the name string of the specified action
*
- * @param action EailBubble instance
+ * Implementation of get_name from AtkAction interface.
+ *
+ * @param action AtkAction instance
* @param i action index
*
- * @return action name
+ * @return string representing the specified action's name
*/
static const char*
eail_bubble_action_name_get(AtkAction *action,
}
/**
- * @brief Implementation of do_action from AtkAction interface
+ * @brief Performs the specified action on the object
*
- * @param action EailBubble instance
+ * Implementation of do_action from AtkAction interface.
+ *
+ * @param action AtkAction instance
* @param i action index
*
* @return TRUE on success, FALSE otherwise
* @brief Macro upcasts an instance (obj) of a subclass to the EailBubble
* type
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_BUBBLE(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), \
EAIL_TYPE_BUBBLE, EailBubble))
/**
* @brief Tests whether object (obj) is an instance of EailBubble class
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_IS_BUBBLE(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), \
EAIL_TYPE_BUBBLE))
/** @brief Definition of object structure for Atk EailBubble*/
struct _EailBubble
{
- EailText parent; /*!< parent class object*/
- char *click_description; /*!< click action description*/
+ /** @brief Parent widget whose functionality is being extended */
+ EailText parent;
+ /** @brief "click" action description*/
+ char *click_description;
};
/** @brief Definition of class structure for Atk EailBubble*/
atk_text_interface_init));
/**
- * @brief Implementation of get_image_position from AtkImage interface
+ * @brief Gets the position of the image in the form of a point specifying the images top-left corner
*
- * @param image EailButton instance
- * @param [out] x horizontal coordinate
- * @param [out] y vertical coordinate
- * @param coord_type coord type
+ * Implementation of get_image_position from AtkImage interface.
+ *
+ * @param image AtkImage instance
+ * @param [out] x horizontal coordinate or -1 if value cannot be obtained
+ * @param [out] y vertical coordinate or -1 if value cannot be obtained
+ * @param coord_type specifies whether the coordinates are relative to the screen or to the component's top level window
*/
static void
eail_button_get_image_position(AtkImage *image,
}
/**
- * @brief Implementation of get_image_size from AtkImage interface
+ * @brief Gets the width and height in pixels for the specified image
+ *
+ * The values of width and height are returned as -1 if they
+ * cannot be obtained (for instance, if the object is not onscreen).
+ *
+ * Implementation of get_image_size from AtkImage interface.
*
- * @param image EailButton instance
- * @param [out] width width image
- * @param [out] height height image
+ * @param image AtkImage instance
+ * @param [out] width image width or -1 if value cannot be obtained
+ * @param [out] height image height or -1 if value cannot be obtained
*/
static void
eail_button_get_image_size(AtkImage *image,
}
/**
- * @brief AtkImage iterface initializer
+ * @brief AtkImage interface initializer
*
- * @param iface an AtkImageIface
+ * @param iface AtkImageIface instance
*/
static void
atk_image_interface_init(AtkImageIface *iface)
/**
* @brief Gets text bounded by start_offset and end_offset
*
- * Use g_free() to free the returned string
+ * Use g_free() to free the returned string.
*
- * @param text an AtkText
+ * @param text AtkText instance
* @param start_offset start position
* @param end_offset end position, -1 for the end of the string
*
- * @return string containing text from start_offset up to, but not including
- * end_offset
+ * @return string containing the text from start_offset up to,
+ * but not including end_offset
*/
static gchar*
eail_button_get_text(AtkText *text,
}
/**
- * @brief Gets character at offset
+ * @brief Gets the character at offset
*
- * @param text an AtkText
+ * @param text AtkText instance
* @param offset character offset
- * @returns character at offset
+ * @returns char representing the character at offset
*/
static gunichar
eail_button_get_character_at_offset(AtkText *text,
}
/**
- * @brief Gets text length
+ * @brief Gets the text length
*
- * @param text an AtkText
- * @returns text length
+ * @param text AtkText instance
+ * @returns integer representing the text length
*/
static gint
eail_button_get_character_count(AtkText *text)
/**
* @brief AtkText interface initializer
*
- * @param iface an AtkTextIface
+ * @param iface AtkTextIface instance
*/
static void
atk_text_interface_init(AtkTextIface *iface)
}
/**
- * @brief Notifies atk about button press event
+ * @brief Notifies ATK about button press event
*
- * @param data data that was passed to event
- * @param obj an Evas_Object that received event
+ * @param data data passed to event
+ * @param obj Evas_Object instance that received event
* @param event_info additional event info
*/
static void
}
/**
- * @brief Notifies atk about button release event
+ * @brief Notifies ATK about button release event
*
* @param data passed to callback
- * @param obj object that raised event
+ * @param obj Evas_Object instance that raised event
* @param event_info additional event info
*/
static void
}
/**
- * @brief Click action callback
+ * @brief 'click' action callback
*
- * @param action an AtkAction
+ * @param action AtkAction instance
* @param data user data passed to callback
*
* @returns TRUE if action was successfull, FALSE otherwise
}
/**
- * @brief Press action callback
+ * @brief 'press' action callback
*
- * @param action an AtkAction
+ * @param action AtkAction instance
* @param data user data passed to callback
*
* @returns TRUE if action was successfull, FALSE otherwise
}
/**
- * @brief Release action callback
+ * @brief 'release' action callback
*
- * @param action an AtkAction
+ * @param action AtkAction instance
* @param data user data passed to callback
*
* @returns TRUE if action was successfull, FALSE otherwise
/**
* @brief Sets EailButton actions
*
- * @param action_widget an EailActionWidget
+ * @param action_widget EailActionWidget instance
*/
static void
eail_button_actions_init(EailActionWidget *action_widget)
/**
* @brief EailButton object initialization
*
- * @param obj EailButton object
+ * @param obj AtkObject instance
* @param data user set additional initialization data
*/
static void
}
/**
- * @brief Gets list of child widget
+ * @brief Gets the list of widget's children
*
- * @param widget EailWidget object
+ * @param widget EailWidget instance
*
- * @returns list of child, NULL if no children
+ * @returns Eina_list representing the list of children
+ * or NULL if widget has no children
*/
static Eina_List *
eail_button_get_widget_children(EailWidget *widget)
}
/**
- * @brief Gets obj accessible name
+ * @brief Gets the accessible name of obj
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*
- * @returns obj name
+ * @returns string representing the accessible name of obj
*/
static const gchar*
eail_button_get_name(AtkObject *obj)
/**
* @brief GObject type initialization function
*
- * @param klass EailButton class
+ * @param klass EailButtonClass instance
*/
static void
eail_button_class_init(EailButtonClass *klass)
/**
* @brief EailButton instance initializer
*
- * @param button an EailButton
+ * @param button EailButton instance
*/
static void
eail_button_init(EailButton *button)
* @brief Macro upcasts an instance (obj) of a subclass to the EailButton
* type
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_BUTTON(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), \
EAIL_TYPE_BUTTON, EailButton))
/**
* @brief Tests whether object (obj) is an instance of EailButton class
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_IS_BUTTON(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), \
EAIL_TYPE_BUTTON))
/** @brief Definition of object structure for Atk EailButton*/
struct _EailButton
{
- /** @brief parent AtkObject that functionality is being extended */
+ /** @brief Parent widget whose functionality is being extended */
EailActionWidget parent;
};
/**
* @brief EailCalendar object initialization
*
- * Main task is to set role for AtkObject.
+ * Sets role of AtkObject.
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
* @param data initialization data
*/
static void eail_calendar_initialize(AtkObject *obj, gpointer data)
* @brief EailCalendar instance initialization
*
* EailCalendar does not have any fields to initialize in struct EailCalendar
- * thus this function is emp but still it has to be defined.
+ * thus this function is empty but still it has to be defined.
*
- * @param calendar EailCalendar instance
+ * @param calendar EailCalendar instance
*/
static void
eail_calendar_init(EailCalendar *calendar)
/**
* @brief EailCalendar class initialization function
*
- * Purpose of this function is to initialize AtkObjectClass method pointers
+ * Unitializes AtkObjectClass method pointers
* with class's implementations.
*
- * @param klass EailCalendar class
+ * @param klass EailCalendarClass instance
*/
static void
eail_calendar_class_init(EailCalendarClass *klass)
}
/**
- * @brief Gets obj current value
+ * @brief Gets the current value of obj
*
- * Gets callendar date
+ * Gets calendar date.
*
* Example:
* @code
* eail_calendar_get_current_value(ATK_VALUE(obj), &value);
* @endcode
*
- * @param obj an AtkValue
- * @param [out] value obj current value for date
+ * @param obj AtkValue instance
+ * @param [out] value obj's current value for date
*/
static void
eail_calendar_get_current_value(AtkValue *obj,
}
/**
- * @brief Gets obj maxiumum value
+ * @brief Gets the maxiumum value of obj
*
- * Gets maximum date that can be set for callendar.
+ * Gets the maximum date that can be set for calendar.
*
* Example:
* @code
* eail_calendar_get_maximum_value(ATK_VALUE(obj), &value);
* @endcode
*
- * @param obj an AtkValue
- * @param [out] value obj maxiumum value
+ * @param obj AtkValue instance
+ * @param [out] value obj's maxiumum value
*/
static void
eail_calendar_get_maximum_value(AtkValue *obj,
}
/**
- * @brief Gets obj minimum value
+ * @brief Gets the minimum value of obj
*
- * Gets minimum date than can be set for callendar
+ * Gets the minimum date than can be set for calendar.
*
* Example:
* @code
* eail_calendar_get_minimum_value(ATK_VALUE(obj), &value);
* @endcode
*
- * @param obj an AtkObject
- * @param [out] value obj minimum value
+ * @param obj AtkObject instance
+ * @param [out] value obj's minimum value
*/
static void
eail_calendar_get_minimum_value(AtkValue *obj,
}
/**
- * @brief Sets obj value
+ * @brief Sets the value of obj
*
* Sets calendar date.
*
* eail_calendar_set_current_value(ATK_VALUE(obj), &value);
* @endcode
*
- * @param obj an AtkValue
- * @param value obj new value
- * @return TRUE if new value is set successfully, FALSE otherwise
+ * @param obj AtkValue instance
+ * @param value obj's new value
+ * @return TRUE if new value was set successfully, FALSE otherwise
*/
static gboolean
eail_calendar_set_current_value(AtkValue *obj,
}
/**
- * @brief Gets obj minimum increment
+ * @brief Gets the minimum increment of obj
*
- * Gets minimum calendar increment i.e one second.
+ * Gets the minimum calendar increment i.e one second.
*
* Example:
*
* eail_calendar_get_minimum_increment(ATK_VALUE(obj), &value);
* @endcode
*
- * @param obj an AtkValue
- * @param [out] value obj minimum increment
+ * @param obj AtkValue instance
+ * @param [out] value obj's minimum increment
*/
static void
eail_calendar_get_minimum_increment(AtkValue *obj,
* implementation i.e hooks method pointers in the interface structure
* to the implementing class's implementation.
*
- * @param iface an AtkObject than implements AtkValueInterface
+ * @param iface AtkObject instance than implements AtkValueInterface
*/
static void
atk_value_interface_init(AtkValueIface *iface)
* @brief Macro upcasts an instance (obj) of a subclass to the EailCalendar
* type
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_CALENDAR(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), \
EAIL_TYPE_CALENDAR, EailCalendar))
/**
* @brief Tests whether object (obj) is an instance of EailCalendar class
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_IS_CALENDAR(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), \
EAIL_TYPE_CALENDAR))
/** @brief Definition of object structure for Atk EailCalendar*/
struct _EailCalendar
{
- EailWidget parent; /*!< @brief parent object that functionality is being extended*/
+ EailWidget parent; /*!< @brief Parent widget whose functionality is being extended*/
};
/** @brief Definition of class structure for Atk EailCalendar*/
/**
* @file eail_check.c
- * @brief EailChceck implementation
+ * @brief EailCheck implementation
*/
#include <Elementary.h>
/**
* @brief Implementation of get_image_position from AtkImage interface
*
- * @param image Eailcheck instance
- * @param [out] x horizontal coordinate
- * @param [out] y vertical coordinate
- * @param coord_type coord type
+ * Gets the position of the image in the form of a point specifying the images top-left corner.
+ *
+ * @param image AtkImage instance
+ * @param [out] x horizontal coordinate or -1 if value cannot be obtained
+ * @param [out] y vertical coordinate or -1 if value cannot be obtained
+ * @param coord_type specifies whether the coordinates are relative to the screen
+ * or to the component's top level window
*/
static void
eail_check_get_image_position(AtkImage *image,
}
/**
- * @brief Implementation of get_image_size from AtkImage interface
+ * @brief Gets the width and height in pixels for the specified image
+ *
+ * The values of width and height are returned as -1 if they
+ * cannot be obtained (for instance, if the object is not onscreen).
*
- * @param image Eailcheck instance
- * @param [out] width width image
- * @param [out] height height image
+ * Implementation of get_image_size from AtkImage interface.
+ *
+ * @param image AtkImage instance
+ * @param [out] width image width or -1 if value cannot be obtained
+ * @param [out] height image height or -1 if value cannot be obtained
*/
static void
eail_check_get_image_size(AtkImage *image,
}
/**
- * @brief AtkImage iterface initializer
+ * @brief AtkImage interface initializer
*
- * @param iface an AtkImageIface
+ * @param iface AtkImageIface instance
*/
static void
atk_image_interface_init(AtkImageIface *iface)
/**
* @brief Gets text bounded by start_offset and end_offset
*
- * Use g_free() to free the returned string
+ * Use g_free() to free the returned string.
*
- * @param text an AtkText
+ * @param text AtkText instance
* @param start_offset start position
* @param end_offset end position, -1 for the end of the string
- * @return string containing text from start_offset up to, but not including
- * end_offset
+ * @return string containing text from start_offset up to,
+ * but not including end_offset
*/
static gchar*
eail_check_get_text(AtkText *text,
}
/**
- * @brief Gets character at offset
+ * @brief Gets the character at offset
*
- * @param text an AtkText
+ * @param text AtkText instance
* @param offset character offset
- * @return character at offset
+ * @return char representing the character at offset
*/
static gunichar
eail_check_get_character_at_offset(AtkText *text,
}
/**
- * @brief Gets text length
+ * @brief Gets the text length
*
- * @param text an AtkText
- * @return text length
+ * @param text AtkText instance
+ * @return integer representing the text length
*/
static gint
eail_check_get_character_count(AtkText *text)
* implementation i.e hooks method pointers in the interface structure
* to the implementing class's implementation.
*
- * @param iface an AtkTextIface
+ * @param iface AtkTextIface instance
*/
static void
atk_text_interface_init(AtkTextIface *iface)
/**
* @brief Callback for on_changed event
- * This will be called to notify AtkObject about object state change
+ *
+ * Called to notify AtkObject about an object's state change.
*
* @param data callback data
- * @param obj object source
+ * @param obj source object
* @param event_info event info
*/
static void
/**
* @brief Action handler for 'click'
*
- * @param action an AtkAction object (EailCheck)
+ * @param action AtkAction instance (EailCheck)
* @param data additional data (unused here)
*
* @returns TRUE on success, FALSE otherwise
/**
* @brief Initializer for actions defined in EailCheck
*
- * @param action_widget an EailActionWidget implementation to be filled
+ * @param action_widget EailActionWidget implementation to be filled
*/
static void
eail_check_actions_init(EailActionWidget *action_widget)
}
/**
- * @brief Implementation of ref_state_set from AtkObject
+ * @brief Gets a reference to the state set of the accessible
*
- * @param obj EailCheck instance
+ * The caller must unreference it when it is no longer needed.
+ *
+ * Implementation of ref_state_set from AtkObject.
*
- * @returns AtkStateSet for EailCheck instance
+ * @param obj AtkObject instance
+ *
+ * @returns AtkStateSet representing the state set
+ * of the accessible
*/
static AtkStateSet*
eail_check_ref_state_set(AtkObject *obj)
}
/**
- * @brief Gets obj accessible name
+ * @brief Gets the accessible name of obj
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*
- * @returns obj name
+ * @returns string representing the accessible name of obj
*/
static const gchar*
eail_check_get_name(AtkObject *obj)
}
/**
- * @brief Gets list of child widget
+ * @brief Gets the list of widget's children
*
- * @param widget EailWidget object
+ * @param widget EailWidget instance
*
- * @return list of children, NULL if no children
+ * @return Eina_list representing the list of children
+ * or NULL if widget has no children
*/
static Eina_List *
eail_check_get_widget_children(EailWidget *widget)
/**
* @brief EailCheck instance initialization
*
- * @param check Eailheck instance
+ * @param check AtkObject instance
*/
static void
eail_check_init(EailCheck *check)
}
/**
- * @brief EailCheck object initializiation
+ * @brief EailCheck object initialization
*
- * @param obj EailCheck object
+ * @param obj EailCheck instance
* @param data user set addtional initailization data
*/
static void
/**
* @brief GObject type initialization function
*
- * @param klass EailCheck class
+ * @param klass EailCheckClass instance
*/
static void
eail_check_class_init(EailCheckClass *klass)
* @brief Macro upcasts an instance (obj) of a subclass to the EailCheck
* type
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_CHECK(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), \
EAIL_TYPE_CHECK, EailCheck))
/**
* @brief Tests whether object (obj) is an instance of EailCheck class
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_IS_CHECK(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), \
EAIL_TYPE_CHECK))
/** @brief Definition of object structure for Atk EailCheck*/
struct _EailCheck
{
- EailActionWidget parent; /*!< @brief parent object that functionality is being extended*/
+ EailActionWidget parent; /*!< @brief Parent widget whose functionality is being extended*/
};
/** @brief Definition of class structure for Atk EailCheck*/
* @brief EailClock object initialization
*
* @param obj EailClock object
- * @param data user set additional initialization data
+ * @param data additional initialization data
*/
static void
eail_clock_initialize(AtkObject *obj, gpointer data)
/**
* @brief GObject type initialization function
*
- * @param klass EailClock class
+ * @param klass EailClockClass instance
*/
static void
eail_clock_class_init(EailClockClass *klass)
*/
/**
- * @brief Gets obj current value
+ * @brief Gets obj's current value
*
* @param obj EailClock instance
- * @param [out] value EailClock current value
+ * @param [out] value obj's current value
*/
static void
eail_clock_get_current_value(AtkValue *obj,
}
/**
- * @brief Gets obj maxiumum value
+ * @brief Gets obj's maxiumum value
*
* @param obj EailClock instance
- * @param [out] value EailClock maxiumum value
+ * @param [out] value obj's maxiumum value
*/
static void
eail_clock_get_maximum_value(AtkValue *obj,
}
/**
- * @brief Gets obj minimum value
+ * @brief Gets obj's minimum value
*
* @param obj EailClock instance
- * @param [out] value EailClock minimum value
+ * @param [out] value obj's minimum value
*/
static void
eail_clock_get_minimum_value(AtkValue *obj,
}
/**
- * @brief Sets obj value
+ * @brief Sets obj's value
*
* @param obj EailClock instance
- * @param value EailClock new value
- * @return TRUE if new value is set successfully, FALSE otherwise
+ * @param value obj's new value
+ * @return TRUE if new value was set successfully, FALSE otherwise
*/
static gboolean
eail_clock_set_current_value(AtkValue *obj,
}
/**
- * @brief Gets obj minimum increment
+ * @brief Gets obj's minimum increment
*
* @param obj EailClock instance
- * @param [out] value EailClock minimum increment
+ * @param [out] value obj's minimum increment
*/
static void
eail_clock_get_minimum_increment(AtkValue *obj,
/**
* @brief Initialization of AtkValue interface
*
- * Function called upon instance creation. It initializes AtkValue interface
+ * @brief Function called upon instance creation.
+ *
+ * It initializes AtkValue interface
* implementation i.e hooks method pointers in the interface structure
* to the implementing class's implementation.
*
- * @param iface an AtkObject than implements AtkValueInterface
+ * @param iface AtkObject that implements AtkValueInterface
*/
static void
atk_value_interface_init(AtkValueIface *iface)
* @brief Macro upcasts an instance (obj) of a subclass to the EailClock
* type
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_CLOCK(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), \
EAIL_TYPE_CLOCK, EailClock))
/**
* @brief Tests whether object (obj) is an instance of EailClock class
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_IS_CLOCK(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), \
EAIL_TYPE_CLOCK))
/** @brief Definition of object structure for Atk EailClock*/
struct _EailClock
{
- EailWidget parent; /*!< parent object that functionality is being extended*/
+ /** @brief Parent widget whose functionality is being extended */
+ EailWidget parent;
};
/** @brief Definition of class structure for Atk EailClock*/
/**
* @brief EailColorselector initializer
*
- * @param obj an AtkObject
- * @param data initialization data (Evas_Object*)
+ * @param obj AtkObject instance
+ * @param data initialization data
*/
static void
eail_colorselector_initialize(AtkObject *obj, gpointer data)
/**
* @brief EailColorselector instance initializer
*
- * @param selector an EailColorselector
+ * @param selector EailColorselector instance
*/
static void
eail_colorselector_init(EailColorselector *selector)
/**
* @brief EailColorselector class initializer
*
- * @param klass an EailColorselector class
+ * @param klass EailColorselectorClass instance
*/
static void
eail_colorselector_class_init(EailColorselectorClass *klass)
}
/**
- * @brief Gets obj current value
+ * @brief Gets obj's current value
*
- * @param obj an AtkValue
- * @param [out] value obj current value
+ * @param obj AtkValue instance
+ * @param [out] value obj's current value
*/
static void
eail_colorselector_get_current_value(AtkValue *obj,
}
/**
- * @brief Gets obj maxiumum value
+ * @brief Gets obj's maxiumum value
*
- * @param obj an AtkValue
- * @param [out] value obj maximum value
+ * @param obj AtkValue instance
+ * @param [out] value obj's maximum value
*/
static void
eail_colorselector_get_maximum_value(AtkValue *obj,
}
/**
- * @brief Gets obj minimum value
+ * @brief Gets obj's minimum value
*
- * @param obj an AtkValue
- * @param [out] value obj minimum value
+ * @param obj AtkValue instance
+ * @param [out] value obj's minimum value
*/
static void
eail_colorselector_get_minimum_value(AtkValue *obj,
}
/**
- * @brief Sets obj current value
+ * @brief Sets obj's current value
*
- * @param obj an AtkValue
- * @param value obj current value
- * @return TRUE if value is set successfully, FALSE otherwise
+ * @param obj AtkValue instance
+ * @param value obj's current value
+ * @return TRUE if value was set successfully, FALSE otherwise
*/
static gboolean
eail_colorselector_set_current_value(AtkValue *obj,
}
/**
- * @brief Gets obj minimum increment
+ * @brief Gets obj's minimum increment
*
- * @param obj an AtkValue
- * @param [out] value obj minimum increment
+ * @param obj AtkValue instance
+ * @param [out] value obj's minimum increment
*/
static void
eail_colorselector_get_minimum_increment(AtkValue *obj,
/**
* @brief AtkValue interface initializer
*
- * @param iface AtkValueIface
+ * @param iface AtkValueIface instance
*/
static void atk_value_interface_init(AtkValueIface *iface)
{
/** @brief Definition of object structure for Atk EailColorselector*/
struct _EailColorselector
{
- /** @brief parent object that functionality is being extended */
+ /** @brief Parent widget whose functionality is being extended */
EailWidget parent;
};
/**
* @brief EailConformant initializer
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
* @param data initialization data
*/
static void
/**
* @brief EailConformant instance initializer
*
- * @param conformant an EailConformant
+ * @param conformant EailConformant instance
*/
static void
eail_conformant_init(EailConformant *conformant)
/**
* @brief EailConformant class initializer
*
- * @param klass an EailConformantClass to be filled
+ * @param klass EailConformantClass instance to be filled
*/
static void
eail_conformant_class_init(EailConformantClass *klass)
* @brief Macro upcasts an instance (obj) of a subclass to the EailConformant
* type
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_CONFORMANT(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), \
EAIL_TYPE_CONFORMANT, EailConformant))
/**
* @brief Tests whether object (obj) is an instance of EailConformant class
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_IS_CONFORMANT(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), \
EAIL_TYPE_CONFORMANT))
/** @brief Definition of object structure for Atk EailConformant*/
struct _EailConformant
{
- /** @brief parent object that functionality is being extended */
+ /** @brief Parent widget whose functionality is being extended */
EailLayout parent;
};
/**
* @file eail_ctxpopup.c
- * @brief Implementation of Ctxpopup widget
+ * @brief EailCtxpopup implementation
*/
#include <Elementary.h>
/**
* @brief Initializer for AtkObject
*
- * @param obj an AtkObject
- * @param data Initialization data
+ * @param obj AtkObject instance
+ * @param data initialization data
*/
static void
eail_ctxpopup_initialize(AtkObject *obj, gpointer data)
/**
* @brief Destructor for EailCtxpopup class
*
- * @param object GObject object to be finalized
+ * @param object GObject instance to be finalized
*/
static void
eail_ctxpopup_finalize(GObject *object)
/**
* @brief EailCtxpopup GObject instance initializer
*
- * @param ctxpopup an EailCtxpopup
+ * @param ctxpopup EailCtxpopup instance
*/
static void
eail_ctxpopup_init(EailCtxpopup *ctxpopup)
}
/**
- * @brief Helper function for getting nested content in "elm_popup" widget
+ * @brief Helper function for getting nested content of elm_popup widget
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*
- * @returns nested widget content from "elm_popup" widget
+ * @returns Evas_Object representing the nested widget content
+ * from elm_popup widget
*/
static Evas_Object *
_eail_get_nested_widget(AtkObject *obj)
}
/**
- * @brief Implementation AtkObject->get_n_children callback
+ * @brief Gets the number of accessible children of the accessible
*
- * ATK doc says:\n
- * Gets the number of accessible children of the accessible.
- * @param obj an AtkObject
+ * Implementation AtkObject->get_n_children callback.
*
- * @returns an integer representing the number of accessible children of
+ * @param obj AtkObject instance
+ *
+ * @returns integer representing the number of accessible children of
* the accessible
*/
static gint
}
/**
- * @brief Implementation AtkObject->ref_child callback
+ * @brief Gets a reference to the specified accessible child of the object
+ *
+ * The accessible children are 0-based so the first accessible child
+ * is at index 0, the second at index 1 and so on.
*
- * ATK doc says:\n
- * Gets a reference to the specified accessible child of the object. The
- * accessible children are 0-based so the first accessible child is at index 0,
- * the second at index 1 and so on.
+ * Implementation of AtkObject->ref_child callback.
*
- * @param obj an AtkObject
- * @param i index of a child
+ * @param obj AtkObject instance
+ * @param i index of the child
*
- * @returns an AtkObject representing the specified accessible child of the
- * accessible.
+ * @returns AtkObject representing the specified accessible child of the
+ * accessible
*/
static AtkObject *
eail_ctxpopup_ref_child(AtkObject *obj, gint i)
}
/**
- * @brief Initializer for EailPopup GObject class (defines callbacks for
- * base AtkObject)
+ * @brief Initializer for EailPopup GObject class
+ *
+ * Defines callbacks for base AtkObject.
*
- * @param klass an EailCtxpopupClass
+ * @param klass EailCtxpopupClass instance
*/
static void
eail_ctxpopup_class_init(EailCtxpopupClass *klass)
*/
/**
- * @brief Implementation of get_n_actions from AtkAction interface
+ * @brief Gets the number of accessible actions available on the object
+ *
+ * If there are more than one, the first one is considered
+ * the "default" action of the object.
+ *
+ * Implementation of get_n_actions from AtkAction interface.
*
- * @param action EailCtxpopup instance
+ * @param action AtkAction instance
*
- * @return number of available actions
+ * @return integer representing the number of available actions
*/
static int
eail_ctxpopup_n_actions_get(AtkAction *action)
}
/**
- * @brief Implementation of get_description from AtkAction interface
+ * @brief Gets the description string of the specified action of the object
*
- * @param action EailCtxpopup instance
+ * Implementation of get_description from AtkAction interface.
+ *
+ * @param action AtkAction instance
* @param i action index
*
- * @return action description
+ * @return string representing the specified action's description
*/
static const char*
eail_ctxpopup_description_get(AtkAction *action,
}
/**
- * @brief Implementation of set_descritpion from AtkAction interface
+ * @brief Sets a description of the specified action of the object
+ *
+ * Implementation of set_description from AtkAction interface.
*
- * @param action EailCtxpopup instance
+ * @param action AtkAction instance
* @param i action index
* @param description action description
*
}
/**
- * @brief Implementation of get_name from AtkAction interface
+ * @brief Gets the name string of the specified action of the object
*
- * @param action EailCtxpopup instance
+ * Implementation of get_name from AtkAction interface.
+ *
+ * @param action AtkAction instance
* @param i action index
*
- * @return action name
+ * @return string representing the specified action's name
*/
static const char*
eail_ctxpopup_action_name_get(AtkAction *action,
}
/**
- * @brief Implementation of do_action from AtkAction interface
+ * @brief Performs the specified action on the object
+ *
+ * Implementation of do_action from AtkAction interface.
*
- * @param action EailCtxpopup instance
+ * @param action AtkAction instance
* @param i action index
*
* @return TRUE on success, FALSE otherwise
* implementation i.e hooks method pointers in the interface structure
* to the implementing class's implementation.
*
- * @param iface an AtkActionIface
+ * @param iface AtkActionIface instance
*/
static void
atk_action_interface_init(AtkActionIface *iface)
* @brief Macro upcasts an instance (obj) of a subclass to the EailCtxpopup
* type
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_CTXPOPUP(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), \
EAIL_TYPE_CTXPOPUP, EailCtxpopup))
/**
* @brief Tests whether object (obj) is an instance of EailCtxpopup class
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_IS_CTXPOPUP(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), \
EAIL_TYPE_CTXPOPUP))
/** @brief Definition of object structure for Atk EailCtxpopup*/
struct _EailCtxpopup
{
- EailWidget parent; /*!< parent class object*/
-
- char *dismiss_description; /*!< 'dismiss' action description*/
+ /** @brief Parent widget whose functionality is being extended */
+ EailWidget parent;
+ /** @brief "dismiss" action description*/
+ char *dismiss_description;
};
/** @brief Definition of class structure for Atk EailCtxpopup*/
/**
* @brief EailDatetime object initialization
*
- * @param obj EailDatetime object
- * @param data user set additional initialization data
+ * @param obj EailDatetime instance
+ * @param data additional initialization data
*/
static void
eail_datetime_initialize(AtkObject *obj, gpointer data)
/**
* @brief GObject type initialization function
*
- * @param klass EailDatetime class
+ * @param klass EailDatetimeClass instance
*/
static void
eail_datetime_class_init(EailDatetimeClass *klass)
}
/**
- * @brief Gets obj current value
+ * @brief Gets obj's current value
*
* Example:
* @code
* @endcode
*
* @param obj EailDatetime instance
- * @param [out] value EailDatetime current value
+ * @param [out] value obj's current value
*/
static void
eail_datetime_get_current_value(AtkValue *obj,
}
/**
- * @brief Gets obj maxiumum value
+ * @brief Gets obj's maxiumum value
*
* @param obj EailDatetime instance
- * @param [out] value EailDatetime maximum value
+ * @param [out] value obj's maximum value
*/
static void
eail_datetime_get_maximum_value(AtkValue *obj,
}
/**
- * @brief Gets obj minimum value
+ * @brief Gets obj's minimum value
*
* @param obj EailDatetime instance
- * @param [out] value EailDatetime minimum value
+ * @param [out] value obj's minimum value
*/
static void
eail_datetime_get_minimum_value(AtkValue *obj,
}
/**
- * @brief Sets obj value
+ * @brief Sets obj's value
*
* Example
* @code
*
* @param obj EailDatetime instance
* @param value EailDatetime new value
- * @return TRUE if new value is set successfully, FALSE otherwise
+ * @return TRUE if new value was set successfully, FALSE otherwise
*/
static gboolean
eail_datetime_set_current_value(AtkValue *obj,
}
/**
- * @brief Gets obj minimum increment
+ * @brief Gets obj's minimum increment
*
* @param obj EailDatetime instance
- * @param [out] value EailDatetime minimum increment
+ * @param [out] value obj's minimum increment
*/
static void
eail_datetime_get_minimum_increment(AtkValue *obj,
/**
* @brief AtkValue interface initializer
*
- * @param iface an AtkValueIface
+ * @param iface AtkValueIface instance
*/
static void
atk_value_interface_init(AtkValueIface *iface)
* @brief Macro upcasts an instance (obj) of a subclass to the EailDatetime
* type
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_DATETIME(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), \
EAIL_TYPE_DATETIME, EailDatetime))
/**
* @brief Tests whether object (obj) is an instance of EailDatetime class
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_IS_DATETIME(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), \
EAIL_TYPE_DATETIME))
/** @brief Definition of object structure for Atk EailDatetime*/
struct _EailDatetime
{
- /** @brief Parent object that functionality is being extended*/
+ /** @brief Parent widget whose functionality is being extended*/
EailWidget parent;
};
/**
* @file eail_dayselector.c
- * @brief Implementation of eail representation of dayselector elementary widget
+ * @brief EailDayselector implementation
*/
#include <Elementary.h>
/**
* @brief Initializer for AtkObjectClass
*
- * @param obj an AtkObject
- * @param data initialization data (Evas_Object*)
+ * @param obj AtkObject instance
+ * @param data initialization data
*/
static void
eail_dayselector_initialize(AtkObject *obj, gpointer data)
/**
* @brief GObject-initializer for EailDayselector
*
- * @param button an EailDayselector
+ * @param button EailDayselector instance
*/
static void
eail_dayselector_init(EailDayselector *button)
}
/**
- * @brief Implementation AtkObject->get_n_children callback
+ * @brief Gets the number of accessible children of the accessible.
*
- * ATK doc says:\n
- * Gets the number of accessible children of the accessible.
+ * Implementation of AtkObject->get_n_children callback.
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*
- * @returns an integer representing the number of accessible children of
+ * @returns integer representing the number of accessible children of
* the accessible
*/
static gint
}
/**
- * @brief Helper func for generating content string name for given day number
- * @param day_num number of day in week
+ * @brief Helper function for generating content string name for given day number
+ * @param day_num integer which represents a particular day of the week
*
- * @returns an Eina_Strbuf* object filled with content day-name
+ * @returns Eina_Strbuf object filled with content day-name
*/
static Eina_Strbuf *
_eail_dayselector_gen_day_str(int day_num)
}
/**
- * @brief Helper func for creating dayselector child content
+ * @brief Helper function for creating the content of dayselector's child
+ *
+ * Unref it when it is no longer needed.
*
* @param day_check_widget check widget that represents a day in dayselector
* widget
*
- * @returns an AtkObject representation of given day in dayselector. Unref
- * it when it is no longer needed.
+ * @returns AtkObject representing a given day in dayselector.
*/
static AtkObject *
_eail_create_dayselector_child(Evas_Object *day_check_widget)
}
/**
- * @brief Implementation AtkObject->ref_child callback
+ * @brief Gets a reference to the specified accessible child of the object.
*
- * ATK doc says:\n
- * Gets a reference to the specified accessible child of the object. The
- * accessible children are 0-based so the first accessible child is at index 0,
+ * The accessible children are 0-based so the first accessible child is at index 0,
* the second at index 1 and so on.
*
- * @param obj an AtkObject
+ * Implementation of AtkObject->ref_child callback.
+ *
+ * @param obj AtkObject instance
* @param i child index
*
- * @returns an AtkObject representing the specified accessible child of the
- * accessible.
+ * @returns AtkObject representing the specified accessible child of the
+ * accessible
*/
static AtkObject *
eail_dayselector_ref_child(AtkObject *obj, gint i)
}
/**
- * @brief Initializer for GObject EailDayselectorClass class (defines callbacks
- * for base AtkObject)
+ * @brief Initializer for GObject EailDayselectorClass class
+ *
+ * Defines callbacks for base AtkObject.
*
- * @param klass an EailDayselectorClass
+ * @param klass EailDayselectorClass instance
*/
static void
eail_dayselector_class_init(EailDayselectorClass *klass)
* @brief Macro upcasts an instance (obj) of a subclass to the EailDayselector
* type
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_DAYSELECTOR(obj) (G_TYPE_DAYSELECTOR_INSTANCE_CAST((obj), \
EAIL_TYPE_DAYSELECTOR, EailDayselector))
/**
* @brief Tests whether object (obj) is an instance of EailDayselector class
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_IS_DAYSELECTOR(obj) (G_TYPE_DAYSELECTOR_INSTANCE_TYPE((obj), \
EAIL_TYPE_DAYSELECTOR))
/** @brief Definition of object structure for Atk EailDayselector*/
struct _EailDayselector
{
- /** @brief Parent object that functionality is being extended*/
+ /** @brief Parent widget whose functionality is being extended*/
EailWidget parent;
};
/**
* @file eail_diskselector.c
- * @brief Implementation of Diskselector widget
+ * @brief EailDiskselector implementation
*/
#include <Elementary.h>
/**
* @brief Initializer for AtkObjectClass
*
- * @param obj an AtkObject
- * @param data Initialization data
+ * @param obj AtkObject instance
+ * @param data initialization data
*/
static void
eail_diskselector_initialize(AtkObject *obj, gpointer data)
/**
* @brief Initializer for GObject EailList instance
*
- * @param diskselector an EailDiskselector
+ * @param diskselector EailDiskselector instance
*/
static void
eail_diskselector_init(EailDiskselector *diskselector)
}
/**
- * @brief Implementation AtkObject->get_n_children callback
+ * @brief Gets the number of accessible children of the accessible.
*
- * ATK doc says:\n
- * Gets the number of accessible children of the accessible.
+ * Implementation of AtkObject->get_n_children callback.
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*
- * @returns an integer representing the number of accessible children of
+ * @returns integer representing the number of accessible children of
* the accessible
*/
static gint
}
/**
- * @brief Implementation AtkObject->ref_child callback
+ * @brief Gets a reference to the specified accessible child of the object.
*
- * ATK doc says:\n
- * Gets a reference to the specified accessible child of the object. The
- * accessible children are 0-based so the first accessible child is at index 0,
+ * The accessible children are 0-based so the first accessible child is at index 0,
* the second at index 1 and so on.
*
- * @param obj an AtkObject
+ * Implementation of AtkObject->ref_child callback.
+ *
+ * @param obj AtkObject instance
* @param i child index
*
- * @returns an AtkObject representing the specified accessible child of the
- * accessible.
+ * @returns AtkObject representing the specified accessible child of the
+ * accessible
*/
static AtkObject *
eail_diskselector_ref_child(AtkObject *obj, gint i)
}
/**
- * @brief Initializer for GObject EailDiskselectorClass class (defines callbacks
- * for base AtkObject)
+ * @brief Initializer for GObject EailDiskselectorClass class
+ *
+ * Defines callbacks for base AtkObject.
*
- * @param klass an EailDiskselectorClass
+ * @param klass EailDiskselectorClass instance
*/
static void
eail_diskselector_class_init(EailDiskselectorClass *klass)
*/
/**
- * @brief Implementation of AtkSelection->add_selection callback
+ * @brief Adds the specified accessible child of the object to the object's selection.
*
- * As described in ATK doc:\n
- * Adds the specified accessible child of the object to the object's selection.
+ * Implementation of AtkSelection->add_selection callback.
*
- * @param selection an AtkSelection
+ * @param selection AtkSelection instance
* @param i selection index
*
- * @returns TRUE if operation ended successfully, FALSE otherwise
+ * @returns TRUE if operation was successful, FALSE otherwise
*/
static gboolean
eail_selection_add_selection(AtkSelection *selection,
}
/**
- * @brief Implementation of AtkSelection->clear_selection callback
- *
- * As described in ATK doc:\n
- * Clears the selection in the object so that no children in the object are
+ * @brief Clears the selection in the object so that no children in the object are
* selected.
*
- * @param selection an AtkSelection
+ * Implementation of AtkSelection->clear_selection callback.
+ *
+ * @param selection AtkSelection instance
*
* @returns always FALSE - this operation is not supported for Diskselector
*/
}
/**
- * @brief Implementation of AtkSelection->ref_selection callback
+ * @brief Gets a reference to the accessible object representing the specified selected
+ * child of the object.
*
- * As described in ATK doc:\n
- * Gets a reference to the accessible object representing the specified selected
- * child of the object. Note: callers should not rely on NULL or on a zero value
+ * Note: callers should not rely on NULL or on a zero value
* for indication of whether AtkSelectionIface is implemented, they should use
* type checking/interface checking macros or the atk_get_accessible_value()
* convenience method.
*
- * @param selection an AtkSelection
+ * Implementation of AtkSelection->ref_selection callback.
+ *
+ * @param selection AtkSelection instance
* @param i selection index
*
- * @returns an AtkObject representing the selected accessible , or NULL if
+ * @returns AtkObject representing the selected accessible or NULL if
* selection does not implement this interface
*/
static AtkObject *
}
/**
- * @brief Implementation of AtkSelection->get_selection_count callback
+ * @brief Gets the number of accessible children currently selected.
*
- * As described in ATK doc:\n
- * Gets the number of accessible children currently selected. Note: callers
- * should not rely on NULL or on a zero value for indication of whether
+ * Note: callers should not rely on NULL or on a zero value for indication of whether
* AtkSelectionIface is implemented, they should use type checking/interface
* checking macros or the atk_get_accessible_value() convenience method.
*
- * @param selection an AtkSelection
+ * Implementation of AtkSelection->get_selection_count callback.
+ *
+ * @param selection AtkSelection instance
*
* @returns always '1' - in Diskselector widget something is always selected
*/
}
/**
- * @brief Implementation of AtkSelection->is_child_selected callback
+ * @brief Determines if the current child of this object is selected.
*
- * As described in ATK doc:\n
- * Determines if the current child of this object is selected Note: callers
- * should not rely on NULL or on a zero value for indication of whether
+ * Note: callers should not rely on NULL or on a zero value for indication of whether
* AtkSelectionIface is implemented, they should use type checking/interface
* checking macros or the atk_get_accessible_value() convenience method.
*
- * @param selection an AtkSelection
+ * Implementation of AtkSelection->is_child_selected callback.
+ *
+ * @param selection AtkSelection instance
* @param i child index
*
- * @returns a gboolean representing the specified child is selected, or 0 if
- * selection does not implement this interface.
+ * @returns gboolean representing the specified child is selected, or 0 if
+ * selection does not implement this interface
*/
static gboolean
eail_selection_is_child_selected(AtkSelection *selection,
}
/**
- * @brief Implementation of AtkSelection->remove_selection callback
+ * @brief Removes the specified child of the object from the object's selection.
*
- * As described in ATK doc:\n
- * Removes the specified child of the object from the object's selection.
+ * Implementation of AtkSelection->remove_selection callback.
*
- * @param selection an AtkSelection
+ * @param selection AtkSelection instance
* @param i selection index
*
- * @returns TRUE if success, FALSE otherwise.
+ * @returns TRUE on success, FALSE otherwise
*/
static gboolean
eail_selection_remove_selection(AtkSelection *selection,
}
/**
- * @brief Implementation of AtkSelection->select_all_selection callback
- *
- * As described in ATK doc:\n
- * Causes every child of the object to be selected if the object supports
+ * @brief Causes every child of the object to be selected if the object supports
* multiple selections.
*
- * @param selection an AtkSelection
+ * Implementation of AtkSelection->select_all_selection callback.
+ *
+ * @param selection AtkSelection instance
*
* @returns FALSE - this operation is not supported for Diskselector widget
*/
* implementation i.e hooks method pointers in the interface structure
* to the implementing class's implementation.
*
- * @param iface an AtkSelectionIface
+ * @param iface AtkSelectionIface instance
*/
static void atk_selection_interface_init(AtkSelectionIface *iface)
{
}
/**
- * @brief Get name of disk selector child
+ * @brief Gets the name of a diskselector's child
*
- * @param parent EailDiskselector instance
- * @param item EailDiskselector child instance
+ * @param parent EailItemParent instance
+ * @param item EailItem child instance
*
- * @returns const gchar * representing name of the child
+ * @returns string representing the name of the child
*/
static const gchar *
eail_diskselector_item_name_get(EailItemParent *parent, EailItem *item)
/**
* @brief Initialization of EailItemParentIface callbacks
*
- * @param iface an EailItemParentIface
+ * @param iface EailItemParentIface instance
*/
static void
eail_item_parent_interface_init(EailItemParentIface *iface)
}
/**
- * @brief Next action callback
+ * @brief 'next' action callback
*
- * @param action an AtkAction
+ * @param action AtkAction instance
* @param data data passed to callback
* @return TRUE on success, FALSE otherwise
*/
}
/**
- * @brief Prev action callback
+ * @brief 'prev' action callback
*
- * @param action an AtkAction
+ * @param action AtkAction instance
* @param data data passed to callback
* @return TRUE on success, FALSE otherwise
*/
/**
* @brief Adds actions for scrolling to actions table
- * @param widget widget that implements EailScrollable interface
+ * @param widget EailDiskselector instance
*/
static void
eail_diskselector_actions_table_init(EailDiskselector *widget)
* @brief Macro upcasts an instance (obj) of a subclass to the EailDiskselector
* type
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_DISKSELECTOR(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), \
EAIL_TYPE_DISKSELECTOR, EailDiskselector))
/**
* @brief Tests whether object (obj) is an instance of EailDiskselector class
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_IS_DISKSELECTOR(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), \
EAIL_TYPE_DISKSELECTOR))
/** @brief Definition of object structure for Atk EailDiskselector*/
struct _EailDiskselector
{
- /** @brief Parent object that functionality is being extended*/
+ /** @brief Parent widget whose functionality is being extended*/
EailScrollableWidget parent;
};
/**
* @file eail_entry.c
- * @brief Implementation of entry widget
+ * @brief EailEntry implementation
*/
#include <Elementary.h>
* @brief Definition of EailEntry as GObject
*
* EailEntry is extended EAIL_TYPE_TEXT with ATK_TYPE_TEXT and
- * ATK_TYPE_EDITABLE_TEXT interfaces implemented
+ * ATK_TYPE_EDITABLE_TEXT interfaces implemented.
+ *
*/
G_DEFINE_TYPE_WITH_CODE(EailEntry,
eail_entry,
atk_editable_text_interface_init));
/**
- * @brief handler for event which is raised when entry content is being changed
+ * @brief Handler for event which is raised when entry content has changed
*
- * @param data passed to callback
- * @param obj object that raised event
+ * @param data data passed to callback
+ * @param obj Evas_Object that raised event
* @param event_info additional event info
*/
void
/**
* @brief Initializer for AtkObject
*
- * @param obj an AtkObject
- * @param data Initialization data
+ * @param obj AtkObject instance
+ * @param data initialization data
*/
static void
eail_entry_initialize(AtkObject *obj, gpointer data)
/**
* @brief Class destructor
*
- * @param obj object instance
+ * @param obj GObject instance
*/
static void
eail_entry_finalize(GObject *obj)
}
/**
- * @brief Implementation of AtkObject->ref_state_set callback
+ * @brief Gets a reference to the state set of the accessible
+ *
+ * The caller must unreference it when it is no longer needed.
*
- * ATK doc says:\n
- * Gets a reference to the state set of the accessible; the caller must
- * unreference it when it is no longer needed.
+ * Implementation of AtkObject->ref_state_set callback.
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*
- * @returns a reference to an AtkStateSet which is the state set of the
- * accessible.
+ * @returns AtkStateSet representing the state set of the
+ * accessible
*/
static AtkStateSet *
eail_entry_ref_state_set(AtkObject *obj)
/**
* @brief Initializer for EailEntry GObject implementation
*
- * @param entry an EailEntry
+ * @param entry EailEntry instance
*/
static void
eail_entry_init(EailEntry *entry)
}
/**
- * @brief Initializer for EailPopup GObject class (defines callbacks for
- * base AtkObject)
+ * @brief Initializer for EailPopup GObject class
*
- * @param klass an EailEntryClass
+ * Defines callbacks for base AtkObject.
+ *
+ * @param klass EailEntryClass instance
*/
static void
eail_entry_class_init(EailEntryClass *klass)
}
/**
- * @brief Gets caret offset
+ * @brief Gets the caret offset
*
- * @param text an AtkText
- * @return caret offset
+ * @param text AtkText instance
+ * @return integer representing the caret offset
*/
static gint
eail_entry_get_caret_offset(AtkText *text)
}
/**
- * @brief Sets offset for caret
+ * @brief Sets the caret (cursor) position to the specified offset.
*
- * Implementation of AtkTextIface->set_caret_offset callback<br>
- * ATK doc says:
- * Sets the caret (cursor) position to the specified offset.
+ * Implementation of AtkTextIface->set_caret_offset callback.
*
- * @param text an AtkText
+ * @param text AtkText instance
* @param offset starting position
*
- * @returns TRUE if success, FALSE otherwise.
+ * @returns TRUE on success, FALSE otherwise
*/
static gboolean
eail_entry_set_caret_offset (AtkText *text,
/**
* @brief Gets the number of selected text regions
*
- * @param text an AtkText
- * @returns number of selected text regions
+ * @param text AtkText instance
+ * @returns integer representing the number of
+ * selected text regions
*/
static gint
eail_entry_get_n_selections(AtkText *text)
/**
* @brief Gets text selection from entry
*
- * Implementation of AtkTextIface->get_selection callback
+ * Use g_free() to free the returned string.
*
- * @param text an AtkText
- * @param selection_num The selection number. The selected regions are assigned
+ * The selected regions are assigned
* numbers that correspond to how far the region is from the start of the text.
* The selected region closest to the beginning of the text region is assigned
* the number 0, etc. Note that adding, moving or deleting a selected region can
- * change the numbering.
- * @param start_offset passes back the start position of the selected region
- * @param end_offset passes back the end position of the selected region
+ * change the numbering.
+ *
+ * Implementation of AtkTextIface->get_selection callback.
*
- * @returns a newly allocated string containing the selected text. Use g_free()
- * to free the returned string.
+ * @param text AtkText instance
+ * @param selection_num selection number
+ * @param start_offset start position of the selected region
+ * @param end_offset end position of the selected region
+ *
+ * @returns newly allocated string containing the selected text
*/
static gchar *
eail_entry_get_selection(AtkText *text,
/**
* @brief Adds a selection bounded by the specified offsets
*
- * @param text an AtkText
+ * @param text AtkText instance
* @param start_offset start position of the selection
* @param end_offset offset of the first character after selection
* @returns TRUE on success, FALSE otherwise
* @brief Removes text selection
*
* Only one selection is supported, so
- * selection_number equals 0.
+ * selection number equals 0.
*
- * @param text an AtkText
+ * @param text AtkText instance
* @param selection_num selection number
* @return TRUE on success, FALSE otherwise
*/
/**
* @brief Sets text selection for entry
*
- * Implementation of AtkTextIface->set_selection callback
- *
- * @param text an AtkText
- * @param selection_num The selection number. The selected regions are assigned
+ * The selected regions are assigned
* numbers that correspond to how far the region is from the start of the text.
* The selected region closest to the beginning of the text region is assigned
* the number 0, etc. Note that adding, moving or deleting a selected region can
- * change the numbering.
+ * change the numbering.
+ *
+ * Implementation of AtkTextIface->set_selection callback.
+ *
+ * @param text AtkText instance
+ * @param selection_num selection number
* @param start_pos start position of the selected region
* @param end_pos end position of the selected region
*
- * @returns TRUE if success, FALSE otherwise
+ * @returns TRUE on success, FALSE otherwise
*/
static gboolean
eail_entry_set_selection(AtkText *text,
/**
* @brief Gets text bounded by start_offset and end_offset
*
- * Use g_free() to free the returned string
+ * Use g_free() to free the returned string.
*
- * @param text an AtkText
+ * @param text AtkText instance
* @param start_offset start position
* @param end_offset end position, -1 for the end of the string
- * @return string containing text from start_offset up to, but not including
- * end_offset
+ * @return string containing text from start_offset up to,
+ * but not including end_offset
*/
static gchar*
eail_entry_get_text(AtkText *text,
/**
- * @brief Returns the position that is count characters from the
- * given offset.
+ * @brief Returns the position that is obtained by adding count to the
+ * given offset
*
- * count may be positive or negative.
+ * Count may be positive or negative.
*
- * @param textblock an evas textblock
- * @param offset a character offset
- * @param count the number of characters to move from offset
- * @returns a new position
+ * @param textblock Evas textblock
+ * @param offset character offset
+ * @param count number of characters to move from offset
+ * @returns integer representing the new position
*/
static gint
_eail_move_chars(const Evas_Object *textblock,
}
/**
- * @brief Gets utf8 character at offset
+ * @brief Gets the utf8 character at offset
*
- * @param textblock an evas textblock
- * @param offset a character offset
- * @returns a utf8 character
+ * @param textblock Evas textblock
+ * @param offset character offset
+ * @returns char representing the utf8 character
*/
static gunichar
_eail_get_unichar_at_offset(const Evas_Object *textblock,
}
/**
- * @brief Checks whether character at offset in textblock is a word start
+ * @brief Checks whether the character at offset in textblock is a word's start
*
- * @param textblock an evas textblock
- * @param offset a character offset
+ * @param textblock Evas textblock
+ * @param offset character offset
* @returns TRUE on success, FALSE otherwise
*/
static gboolean
}
/**
- * @brief Checks whether character at offset in textblock is a word end
+ * @brief Checks whether the character at offset in textblock is a word's end
*
- * @param textblock an evas textblock
- * @param offset a character offset
+ * @param textblock Evas textblock
+ * @param offset character offset
* @return TRUE on success, FALSE otherwise
*/
static gboolean
}
/**
- * @brief Check whether character at offset in textblock is inside a word
+ * @brief Checks whether the character at offset in textblock is inside a word
*
- * @param textblock an evas textblock
- * @param offset a character offset
+ * @param textblock Evas textblock
+ * @param offset character offset
* @returns TRUE on success, FALSE otherwise
*/
static gboolean
}
/**
- * @brief Gets texblock length
+ * @brief Gets the texblock length
*
- * @param textblock an evas textblock
- * @returns a textblock length
+ * @param textblock Evas textblock
+ * @returns integer representing the textblock length
*/
static gint
_eail_get_len(const Evas_Object *textblock)
}
/**
- * @brief Returns the position that is count words from the given offset.
+ * @brief Returns the position that is count words from the given offset
*
- * count may be positive or negative. If count is positive, the returned
+ * Count may be positive or negative. If count is positive, the returned
* position will be a word end, otherwise it will be a word start.
*
- * @param textblock an evas textblock
- * @param offset a cahracter offset
+ * @param textblock Evas textblock
+ * @param offset a character offset
* @param count the number of words to move from offset
- * @returns a new position
+ * @returns integer representing the new position
*/
static gint
_eail_move_words(const Evas_Object *textblock,
}
/**
- * @brief Gets position of first character in line
+ * @brief Gets the position of the first character in line
*
- * @param cur an Evas_Textblock_Cursor
+ * @param cur Evas_Textblock_Cursor instance
* @returns TRUE on success, FALSE otherwise
*/
static gint
}
/**
- * @brief Gets position of last character in line
+ * @brief Gets the position of the last character in line
*
- * @param cur an Evas_Textblock_Cursor
+ * @param cur Evas_Textblock_Cursor instance
* @returns TRUE on success, FALSE otherwise
*/
static gint
}
/**
- * @brief Moves cursor to the beginning of the next line
+ * @brief Moves the cursor to the beginning of the next line
*
- * @param cur an Evas_Textblock_Cursor
+ * @param cur Evas_Textblock_Cursor instance
* @returns TRUE on success, FALSE otherwise
*/
static gboolean
}
/**
- * @brief Gets length of the line shown by cursor cur
+ * @brief Gets the length of the line shown by cursor cur
*
- * @param cur an Evas_Textblock_Cursor
- * @return line length
+ * @param cur Evas_Textblock_Cursor instance
+ * @return integer representing the length of the line
*/
static gint
_eail_get_line_length(Evas_Textblock_Cursor *cur)
}
/**
- * @brief Gets before at offset
+ * @brief Gets the line before offset
*
- * @param entry an Evas_Object
- * @param boundary_type an AtkTextBoundary
- * @param offset position
- * @param [out] start_offset the start offset of the returned string
- * @param [out] end_offset the offset of the first character after the
+ * @param entry Evas_Object instance
+ * @param boundary_type AtkTextBoundary instance
+ * @param offset character offset
+ * @param [out] start_offset start offset of the returned string
+ * @param [out] end_offset offset of the first character after the
* returned substring
*/
static void
}
/**
- * @brief Gets line after offset
+ * @brief Gets the line after offset
*
- * @param entry an Evas_Object
- * @param boundary_type an AtkTextBoundary
- * @param offset position
- * @param [out] start_offset the start offset of the returned string
- * @param [out] end_offset the offset of the first character after the
+ * @param entry Evas_Object instance
+ * @param boundary_type AtkTextBoundary instance
+ * @param offset character offset
+ * @param [out] start_offset start offset of the returned string
+ * @param [out] end_offset offset of the first character after the
* returned substring
*/
static void
}
/**
- * @brief Gets line at offset
+ * @brief Gets the line at offset
*
- * @param entry an Evas_Object
- * @param boundary_type an AtkTextBoundary
- * @param offset position
- * @param [out] start_offset the start offset of the returned string
- * @param [out] end_offset the offset of the first character after the
+ * @param entry Evas_Object instance
+ * @param boundary_type AtkTextBoundary instance
+ * @param offset character offset
+ * @param [out] start_offset start offset of the returned string
+ * @param [out] end_offset offset of the first character after the
* returned substring
*/
static void
/**
* @brief Gets a slice of the text from entry after offset
*
- * @param entry an entry widget
- * @param offset a character offset
- * @param boundary_type an AtkTextBoundary
- * @param [out] start_offset return location for the start of the returned text
- * @param [out] end_offset return location for the end of the returned text
- * @returns a newly allocated string containg a slice of text from textblock.
- * Free with g_free()
+ * Use g_free() to free the returned string.
+ *
+ * @param entry entry widget
+ * @param offset character offset
+ * @param boundary_type AtkTextBoundary instance
+ * @param [out] start_offset start position of the returned text
+ * @param [out] end_offset end position of the returned text
+ * @returns newly allocated string containg a slice of text from textblock
*/
static gchar *
_eail_get_text_after(Evas_Object *entry,
/**
* @brief Gets a slice of the text from entry at offset
*
- * @param entry an entry widget
- * @param offset a character offset in entry
- * @param boundary_type an AtkTextBoundary
- * @param [out] start_offset return location for the start of the returned text
- * @param [out] end_offset return location for the end of the return text
- * @returns a newly allocated string containing a slice of text from entry.
- * Free with g_free().
+ * Use g_free() to free the returned string.
+ *
+ * @param entry entry widget instance
+ * @param offset character offset
+ * @param boundary_type AtkTextBoundary instance
+ * @param [out] start_offset start position of the returned text
+ * @param [out] end_offset end position of the return text
+ * @returns newly allocated string containing a slice of text from entry
*/
static gchar *
_eail_get_text_at(Evas_Object *entry,
/**
* @brief Gets a slice of the text from entry before offset
*
- * @param entry an entry widget
- * @param offset a character offset
- * @param boundary_type an AtkTextBoundary
- * @param start_offset return location for the start of the returned text
- * @param end_offset return location for the end of the returned text
- * @returns a newly allocated string containing a slice of text from entry.
- * Free with g_free().
+ * Use g_free() to free the returned string.
+ *
+ * @param entry entry widget instance
+ * @param offset character offset
+ * @param boundary_type AtkTextBoundary instance
+ * @param [out] start_offset start position of the returned text
+ * @param [out] end_offset end position of the returned text
+ * @returns newly allocated string containing a slice of text from entry
*/
static gchar *
_eail_get_text_before(Evas_Object *entry,
}
/**
- * @brief Gets the specified text
+ * @brief Gets the specified text after offset
*
- * @param text an AtkText
- * @param offset position
- * @param boundary_type an AtkTextBoundary
- * @param [out] start_offset the start offset of the returned string
- * @param [out] end_offset the offset of the first character after the returned
+ * Use g_free() to free the returned string.
+ *
+ * @param text AtkText instance
+ * @param offset character offset
+ * @param boundary_type AtkTextBoundary instance
+ * @param [out] start_offset start offset of the returned string
+ * @param [out] end_offset offset of the first character after the returned
* substring
- * @returns a newly allocated string containing the text after offset bounded
- * by the specified boundary_type. Use g_free() to free the returned string.
+ * @returns newly allocated string containing the text after offset bounded
+ * by the specified boundary_type
*/
static gchar *
eail_entry_get_text_after_offset(AtkText *text,
}
/**
- * @brief Gets the specified text
+ * @brief Gets the specified text at offset
+ *
+ * Use g_free() to free the returned string.
*
- * @param text an AtkText
- * @param offset position
- * @param boundary_type an AtkTextBoundary
- * @param [out] start_offset the start offset of the returned string
- * @param [out] end_offset the offset of the first character after the returned
+ * @param text AtkText instance
+ * @param offset character offset
+ * @param boundary_type AtkTextBoundary instance
+ * @param [out] start_offset start offset of the returned string
+ * @param [out] end_offset offset of the first character after the returned
* substring
- * @returns a newly allocated string containing the text after offset bounded
- * by the specified boundary_type. Use g_free() to free the returned string.
+ * @returns newly allocated string containing the text after offset bounded
+ * by the specified boundary_type
*/
static gchar *
eail_entry_get_text_at_offset(AtkText *text,
}
/**
- * @brief Gets the specified text
+ * @brief Gets the specified text before offset
+ *
+ * Use g_free() to free the returned string.
*
- * @param text an AtkText
- * @param offset position
- * @param boundary_type an AtkTextBoundary
- * @param [out] start_offset the start offset of the returned string
- * @param [out] end_offset the offset of the first character after the returned
+ * @param text AtkText instance
+ * @param offset character offset
+ * @param boundary_type AtkTextBoundary instance
+ * @param [out] start_offset start offset of the returned string
+ * @param [out] end_offset offset of the first character after the returned
* substring
- * @returns a newly allocated string containing the text after offset bounded
- * by the specified boundary_type. Use g_free() to free the returned string.
+ * @returns newly allocated string containing the text after offset bounded
+ * by the specified boundary_type
*/
static gchar *
eail_entry_get_text_before_offset(AtkText *text,
}
/**
- * @brief Gets character at offset
+ * @brief Gets the character at offset
*
- * @param text an AtkText
+ * @param text AtkText instance
* @param offset character offset
- * @return character at offset
+ * @return char representing the character at offset
*/
static gunichar
eail_entry_get_character_at_offset(AtkText *text,
}
/**
- * @brief Gets text length
+ * @brief Gets the text's length
*
- * @param text an AtkText
- * @return text length
+ * @param text AtkText instance
+ * @return integer representing the text length
*/
static gint
eail_entry_get_character_count(AtkText *text)
/**
* @brief Adds attribute to attribute set
*
- * @param attrib_set The AtkAttributeSet to add the attribute to
- * @param attr The AtkTextAttrribute which identifies the attribute to be added
- * @param value The attribute value
- *
* Creates an AtkAttribute from attr and value, and adds it
* to attrib_set.
*
- * @returns: A pointer to the new AtkAttributeSet.
+ * @param attrib_set AtkAttributeSet instance to add the attribute to
+ * @param attr AtkTextAttrribute instance which identifies the attribute to be added
+ * @param value attribute value
+ *
+ * @returns: AtkAttributeSet representing the new attribute set
**/
AtkAttributeSet*
eail_entry_add_attribute(AtkAttributeSet *attrib_set,
/**
* @brief Creates an AtkAttributeSet which consists of the default values of
- * attributes for the text.
+ * attributes for the text
*
- * @param text an AtkText
+ * The returned AtkAttributeSet should be freed by a call to
+ * atk_attribute_set_free().
*
- * @returns an AtkAttributeSet which contains the default values of attributes
- * at offset. this atkattributeset should be freed by a call to
- * atk_attribute_set_free()
+ * @param text AtkText instance
+ *
+ * @returns AtkAttributeSet which contains the default values of attributes
+ * at offset
*/
AtkAttributeSet *
eail_entry_get_default_attributes(AtkText *text)
/**
* @brief Creates an AtkAttributeSet which consists of the attributes
- * explicitly set at the position offset in the text. start_offset and
- * end_offset are set to the start and end of the range around offset
- * where the attributes are invariant. Note that end_offset is the offset
- * of the first character after the range.
- *
- * @param text an AtkText
- * @param offset the offset at which to get the attributes
- * @param start_offset the address to put the start offset of the range (used to
- * store output value)
- * @param end_offset the address to put the end offset of the range (used to
- * store output value)
- *
- * @returns an AtkAttributeSet which contains the attributes explicitly set at
- * offset. This AtkAttributeSet should be freed by a call to
+ * explicitly set at the position offset in the text
+ *
+ * start_offset and end_offset are set to the start and end of the range
+ * around offset where the attributes are invariant. Note that end_offset
+ * is the offset of the first character after the range.
+ *
+ * The returned AtkAttributeSet should be freed by a call to
* atk_attribute_set_free()
+ *
+ * @param text AtkText instance
+ * @param offset offset at which to get the attributes
+ * @param [out] start_offset start offset of the range
+ * @param [out] end_offset end offset of the range
+ *
+ * @returns AtkAttributeSet which contains the attributes explicitly set at
+ * offset
*/
AtkAttributeSet *
eail_entry_get_run_attributes(AtkText *text,
/**
* @brief Initializes AtkTextIface interface
*
- * @param iface an AtkTextIface
+ * @param iface AtkTextIface instance
*/
static void
atk_text_interface_init(AtkTextIface *iface)
*/
/**
- * @brief Set text content for entry
- * @param text an AtkEditableText
- * @param string string to be set
+ * @brief Sets text content of entry
+ *
+ * @param text AtkEditableText instance
+ * @param string string to be set as the content of entry
*/
static void
eail_entry_set_text_contents(AtkEditableText *text,
/**
* @brief Copies text content from entry to clipboard
*
- * @param text an AtkEditableText
- * @param start_pos start position of cursor
- * @param end_pos end position of cursor
+ * @param text AtkEditableText instance
+ * @param start_pos start position of the cursor
+ * @param end_pos end position of the cursor
*/
static void
eail_entry_copy_text(AtkEditableText *text,
/**
* @brief Cuts text content from entry to clipboard
*
- * @param text an AtkEditableText
- * @param start_pos start position of cursor
- * @param end_pos end position of cursor
+ * @param text AtkEditableText instance
+ * @param start_pos start position of the cursor
+ * @param end_pos end position of the cursor
*/
static void
eail_entry_cut_text(AtkEditableText *text,
/**
* @brief Pastes text content from clipboard into entry
*
- * @param text an AtkEditableText
- * @param position start position of cursor
+ * @param text AtkEditableText instance
+ * @param position start position of the cursor
*/
static void
eail_entry_paste_text(AtkEditableText *text,
* @brief Deletes text between start_pos and end_pos but not
* including end_pos
*
- * @param text an AtkEditableText
+ * @param text AtkEditableText instance
* @param start_pos start position
* @param end_pos end position
*/
}
/**
- * @brief Inserts text at given position
+ * @brief Inserts text at the specified position
+ *
+ * After the call position points to the position after the newly inserted text.
*
- * @param text an AtkEditableText
+ * @param text AtkEditableText instance
* @param string string to insert
- * @param length string length
- * @param [out] position at witch text is inserted.
- * After the call it points at the position after the newly inserted text.
+ * @param length string's length
+ * @param [out] position position at which text is inserted
*/
static void
eail_entry_insert_text(AtkEditableText *text,
* implementation i.e hooks method pointers in the interface structure
* to the implementing class's implementation.
*
- * @param iface an AtkEditableTextIface
+ * @param iface AtkEditableTextIface instance
*/
static void
atk_editable_text_interface_init(AtkEditableTextIface *iface)
* @brief Macro upcasts an instance (obj) of a subclass to the EailEntry
* type
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_ENTRY(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), \
EAIL_TYPE_ENTRY, EailEntry))
/**
* @brief Tests whether object (obj) is an instance of EailEntry class
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_IS_ENTRY(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), \
EAIL_TYPE_ENTRY))
/** @brief Definition of object structure for Atk EailEntry*/
struct _EailEntry
{
- /** @brief Parent object that functionality is being extended*/
+ /** @brief Parent object whose functionality is being extended*/
EailWidget parent;
/** @brief Selection region start */
gint selection_start;
static Eina_List *eail_cached_objs = NULL;
/**
- * @brief Creates EailFactoryObj instance for given widget and adds it to cache
- * @param atk_obj an AtkObject
- * @param evas_obj an Evas_Object
+ * @brief Creates an EailFactoryObj instance for the given widget and adds it to cache
+ *
+ * @param atk_obj AtkObject instance
+ * @param evas_obj Evas_Object instance
*/
static void
_eail_factory_append_wdgt_to_cache(AtkObject *atk_obj, Evas_Object *evas_obj)
}
/**
- * @brief Tries to find AtkObject representing given Evas_Object* in cache
+ * @brief Tries to find an AtkObject representing the given Evas_Object* in cache
*
- * @param widget an Evas_Object to find in cache
+ * @param widget Evas_Object instance to find in cache
*
- * @returns an EailFactoryObj * object or NULL if widget representation was not
- * found
+ * @returns EailFactoryObj representing the given Evas_Object
+ * or NULL if the widget's representation was not found
*/
static EailFactoryObj *
_eail_factory_find_obj_for_widget(const Evas_Object *widget)
}
/**
- * @brief Creates accessible AtkObject for Evas_Object*
+ * @brief Creates an accessible AtkObject for Evas_Object*
*
- * @param widget an Evas_Object*
+ * Returned AtkObject should be unreferenced when no longer needed to free memory.
*
- * @returns reference to AtkObject* which is accessible representation of given
- * Evas_Object. It should be unreferenced when no longer needed to free memory
+ * @param widget Evas_Object* instance
+ *
+ * @returns AtkObject representing the accessible representation of the specified
+ * Evas_Object
*/
static AtkObject *
_eail_factory_create_accessible(Evas_Object *widget)
/**
- * @brief Creates new EailItem instance with given ATK role
+ * @brief Creates a new EailItem instance with the given ATK role
*
- * @param item an Elm_Object_Item
- * @param parent AtkObject that holds EailItem instance
- * @param role AtkRole that will be used by EailItem
+ * @param item Elm_Object_Item instance
+ * @param parent AtkObject instance that holds EailItem instance
+ * @param role AtkRole instance that will be used by EailItem
*
- * @returns new EailItem instance or NULL in case of error
+ * @returns EailItem representing the new EailItem instance
+ * or NULL in case of an error
*/
static AtkObject *
_eail_factory_create_item_atk_obj(Elm_Object_Item *item,
}
/**
- * @param atk_obj an AtkObject
- * @param item an Elm_Object_Item item
+ * @param atk_obj AtkObject instance
+ * @param item Elm_Object_Item instance
*/
void
eail_factory_append_item_to_cache(AtkObject *atk_obj, Elm_Object_Item *item)
}
/**
- * @param item an Elm_Object_Item* to be found
- * @returns an EailFactoryObj * object or NULL if item representation was not
+ * @param item Elm_Object_Item* instance to be found
+ * @returns EailFactoryObj instance or NULL if item's representation was not
* found
*/
EailFactoryObj *
/**
*
- * If AtkObject was already created for given item, instance will be returned
- * from cache instead of creating new one (it is needed to allow setting and
- * storing name/description changes by multiple clients).
+ * If AtkObject was already created for the given item, instance will be returned
+ * from cache instead of creating a new one (it is needed to allow the setting and
+ * storing of name/description changes by multiple clients).
*
- * @param item an Elm_Object_Item that will be used as source for AtkObject
+ * @param item Elm_Object_Item instance that will be used as a source for the AtkObject
* representation
- * @param role an AtkRole role for given item
- * @param parent object that has given item inside its content (eg. for
+ * @param role role for given item
+ * @param parent AtkObject instance that has the given item inside its content (eg. for
* list-item this will be EailList instance)
*
- * @returns AtkObject * representation or NULL in case of failure
+ * @returns AtkObject representing the item or NULL in case of a failure
*/
AtkObject *
eail_factory_get_item_atk_obj(Elm_Object_Item *item,
factory_obj = eail_factory_find_obj_for_item(item);
if (factory_obj)
{
- /* already found implementation, not need to create new obj, returning
+ /* already found implementation, no need to create new obj, returning
* existing one from cache */
if (!factory_obj->atk_obj)
{
/**
*
- * @param item an Elm_Object_Item* item to be deregistered
+ * @param item Elm_Object_Item* instance to be deregistered
*/
void
eail_factory_unregister_item_from_cache(Elm_Object_Item *item)
/**
*
- * @param widget an Evas_Object* widget to be deregistered
+ * @param widget Evas_Object* instance to be deregistered
*/
void
eail_factory_unregister_wdgt_from_cache(Evas_Object *widget)
}
/**
- * @param widget an Evas_Object*
+ * @param widget Evas_Object* instance
+ *
+ * The returned AtkObject should be unreferenced when no longer needed
+ * to free memory.
*
- * @returns reference to AtkObject* which is accessible representation of given
- * Evas_Object. It should be unreferenced when no longer needed to free memory
+ * @returns AtkObject which is the accessible representation of the specified
+ * Evas_Object
*/
AtkObject *
eail_factory_get_accessible(Evas_Object *widget)
factory_widget = _eail_factory_find_obj_for_widget(widget);
if (factory_widget)
{
- /* already found implementation, not need to create new obj, returning
+ /* already found implementation, no need to create new obj, returning
* existing one from cache */
if (!factory_widget->atk_obj)
{
Elm_Object_Item *obj_item;/**< @brief Elm_Object_Item that needs atk representation*/
};
+/**
+ * @brief Creates an accessible EAIL widget that represents the given Evas_Object*
+ */
AtkObject * eail_factory_get_accessible (Evas_Object *widget);
+
+/**
+ * @brief Returns an instance of AtkObject for the given item
+ */
AtkObject * eail_factory_get_item_atk_obj (Elm_Object_Item *item,
AtkRole role,
AtkObject *parent);
+
+/**
+ * @brief Creates an EailFactoryObj instance for the given item and adds it to cache
+ */
void eail_factory_append_item_to_cache (AtkObject *atk_obj,
Elm_Object_Item *item);
+/**
+ * @brief Tries to find an AtkObject representing the given Elm_Object_Item * in cache
+ */
EailFactoryObj *eail_factory_find_obj_for_item (const Elm_Object_Item *item);
+
+/**
+ * @brief Unregisters a widget and associated AtkObject* representation from
+ * factory cache
+ */
void eail_factory_unregister_wdgt_from_cache(Evas_Object *widget);
+
+/**
+ * @brief Unregisters an item and associated AtkObject* representation from
+ * factory cache
+ */
void eail_factory_unregister_item_from_cache(Elm_Object_Item *item);
Eina_List * eail_factory_find_objects_with_role(AtkRole role);
/**
* @brief Initializer for Fileselector AtkObjectClass
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
* @param data initialization data
*/
static void
}
/**
- * @brief Gets obj accessible name
+ * @brief Gets obj's accessible name
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*
- * @returns obj name
+ * @returns string representing obj's name
*/
static const gchar*
eail_fileselector_get_name(AtkObject *obj)
/**
* @brief EailFileselector GObject instance initializer
*
- * @param fileselector an EailFileselector
+ * @param fileselector EailFileselector instance
*/
static void
eail_fileselector_init(EailFileselector *fileselector)
}
/**
- * @brief Initializer for EailFileselector GObject class (defines callbacks for
- * base AtkObject)
+ * @brief Initializer for EailFileselector GObject class
*
- * @param klass an EailFileselectorClass
+ * Defines callbacks for base AtkObject.
+ *
+ * @param klass EailFileselectorClass instance
*/
static void
eail_fileselector_class_init(EailFileselectorClass *klass)
* @brief Macro upcasts an instance (obj) of a subclass to the EailFileselector
* type
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_FILESELECTOR(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), \
EAIL_TYPE_FILESELECTOR, EailFileselector))
/**
* @brief Tests whether object (obj) is an instance of EailFileselector class
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_IS_FILESELECTOR(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), \
EAIL_TYPE_FILESELECTOR))
/** @brief Definition of object structure for Atk EailFileselector*/
struct _EailFileselector
{
- /** @brief Parent object that functionality is being extended*/
+ /** @brief Parent widget whose functionality is being extended*/
EailLayout parent;
};
/**
* @file eail_fileselector_entry.c
- * @brief Implementation of fileselector entry widget
+ * @brief EailFileselectorEntry implementation
*/
#include <Elementary.h>
* @brief Definition of EailFileselectorEntry as GObject
*
* EailFileselectorEntry is extended EAIL_TYPE_ACTION_WIDGET with ATK_TYPE_TEXT
- * interface implemented
+ * interface implemented.
*/
G_DEFINE_TYPE_WITH_CODE(EailFileselectorEntry,
eail_fileselector_entry,
/**
* @brief Initializer for AtkObject
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
* @param data initialization data
*/
static void
/**
* @brief Initializer for EailEntry GObject implementation
*
- * @param fileselector_entry an EailFileselectorEntry
+ * @param fileselector_entry EailFileselectorEntry instance
*/
static void
eail_fileselector_entry_init(EailFileselectorEntry *fileselector_entry)
}
/**
- * @brief Gets name of FileselectorEntry
+ * @brief Gets the accessible name of FileselectorEntry
*
- * Implementation of AtkObject->get_name callback<br>
- * Name is label-text on button
+ * Name is the label-text on the button.
*
- * ATK doc says:
- * Gets the accessible name of the accessible.
+ * Implementation of get_name from AtkObject interface.
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*
- * @returns a character string representing the accessible description of
- * the accessible.
+ * @returns character string representing the accessible name of
+ * the accessible
*/
static const gchar *
eail_fileselector_entry_get_name(AtkObject *obj)
}
/**
- * @brief Gets nested button from widget (file selector button)
+ * @brief Gets nested button from FileSelectorEntry
*
- * @param obj an AtkObject (EailFileselectorEntry)
- * @returns Evas_Object for file selector button or NULL if not found
+ * @param obj AtkObject instance
+ * @returns Evas_Object representing the file selector button
+ * or NULL if one was not found
*/
static Evas_Object *
_eail_fileselector_entry_get_nested_button(AtkObject *obj)
}
/**
- * @brief Helper func for returning list of nested widgets in fileselector entry
+ * @brief Helper function for returning list of nested widgets in fileselector entry
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*
- * @return list of Evas_Object* objects with nested widgets
+ * @return Eina_list representing the list of Evas_Object* objects with nested widgets
*/
static Eina_List *
_eail_fileselector_entry_get_items(AtkObject *obj)
}
/**
- * @brief Implementation AtkObject->get_n_children callback
+ * @brief Gets the number of accessible children of the accessible
+ *
+ * Implementation of get_n_children from AtkObject interface.
*
- * ATK doc says:\n
- * Gets the number of accessible children of the accessible.
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*
- * @returns an integer representing the number of accessible children of
+ * @returns integer representing the number of accessible children of
* the accessible
*/
static gint
}
/**
- * @brief Implementation AtkObject->ref_child callback
+ * @brief Gets a reference to the specified accessible child of the object
+ *
+ * The accessible children are 0-based so the first accessible child
+ * is at index 0, the second at index 1 and so on.
*
- * ATK doc says:\n
- * Gets a reference to the specified accessible child of the object. The
- * accessible children are 0-based so the first accessible child is at index 0,
- * the second at index 1 and so on.
+ * Implementation of get_n_children from AtkObject interface.
*
- * @param obj an AtkObject
- * @param i index of a child
+ * @param obj AtkObject instance
+ * @param i index of the child
*
- * @returns an AtkObject representing the specified accessible child of the
- * accessible.
+ * @returns AtkObject representing the specified accessible child of the
+ * accessible
*/
static AtkObject *
eail_fileselector_entry_ref_child(AtkObject *obj, gint i)
}
/**
- * @brief Destructor for FileselectorEntry class
+ * @brief Destructor of FileselectorEntry class
*
- * @param object GObject object to be finalized
+ * @param object GObject instance to be finalized
*/
static void
eail_fileselector_entry_finalize(GObject *object)
}
/**
- * @brief Initializer for EailFileselectorEntry GObject class (defines
- * callbacks for base AtkObject)
+ * @brief Initializer for EailFileselectorEntry GObject class
*
- * @param klass an EailFileselectorEntryClass
+ * Defines callbacks for base AtkObject.
+ *
+ * @param klass EailFileselectorEntryClass instance
*/
static void
eail_fileselector_entry_class_init(EailFileselectorEntryClass *klass)
/**
* @brief Gets text content from item
*
- * Implementation of AtkTextIface->get_text callback\n
+ * Implementation of get_text from AtkTextIface.
+ *
+ * Use g_free() to free the returned string.
*
- * @param text an AtkText
+ * @param text AtkText instance
* @param start_offset start position
- * @param end_offset end position, or -1 for the end of the string.
+ * @param end_offset end position, or -1 for the end of the string
*
- * @returns a newly allocated string containing the text from start_offset
- * up to, but not including end_offset. Use g_free() to free the returned
- * string.
+ * @returns newly allocated string containing the text from start_offset
+ * up to, but not including end_offset
*/
static gchar*
eail_fileselector_entry_get_text(AtkText *text,
}
/**
- * @brief Gets character from popup at given offset
+ * @brief Gets the character from popup at the given offset
*
- * Implementation of AtkTextIface->get_character_at_offset callback
+ * Implementation of get_character_at_offset from AtkTextIface.
*
- * @param text an AtkText
- * @param offset an offset
+ * @param text AtkText instance
+ * @param offset character offset
*
- * @returns the character at offset.
+ * @returns char representing the character at offset
*/
static gunichar
eail_fileselector_entry_get_character_at_offset(AtkText *text,
}
/**
- * @brief Gets character count from text content in item
- * Implementation of AtkTextIface->get_character_count callback
+ * @brief Gets the number of characters from text content in item
+ *
+ * Implementation of get_character_count from AtkTextIface.
*
- * @param text an AtkText
+ * @param text AtkText instance
*
- * @returns the character count
+ * @returns integer representing the number of characters in text nontent
*/
static gint
eail_fileselector_entry_get_character_count(AtkText *text)
/**
* @brief Initializer for AtkTextIface interface
*
- * @param iface an AtkTextIface
+ * @param iface AtkTextIface instance
*/
static void
atk_text_interface_init(AtkTextIface *iface)
/**
* @brief Calls callback with given name
*
- * @param action an AtkAction
+ * @param action AtkAction instance
* @param action_name action name to be called
*
- * @returns TRUE if was successful, FALSE otherwise
+ * @returns TRUE on success, FALSE otherwise
*/
static gboolean
eail_fileselector_entry_do_action(AtkAction *action,
}
/**
- * @brief Handle for action click
+ * @brief Handle for 'click' action
*
- * @param action an AtkAction
+ * @param action AtkAction instance
* @param data additional action data (not used here)
*
* @return TRUE if action was triggered successfully, FALSE otherwise
}
/**
- * @brief Calls action for with given name for actions based on x-y coordinates
+ * @brief Calls action with given name for actions based on x-y coordinates
*
- * @param action an AtkAction
- * @param name action name to be called
+ * @param action AtkAction instance
+ * @param name name string of the action to be called
*
- * @returns TRUE if was successful, FALSE otherwise
+ * @returns TRUE on success, FALSE otherwise
*/
static gboolean
_eail_action_handle_coords_action(AtkAction *action, gchar *name)
return TRUE;
}
/**
- * @brief Handle for action longpress
+ * @brief Handle for 'longpress' action
*
- * @param action an AtkAction
+ * @param action AtkAction instance
* @param data additional action data (not used here)
*
* @return TRUE if action was triggered successfully, FALSE otherwise
}
/**
- * @brief Handle for action press
+ * @brief Handle for 'press' action
*
- * @param action an AtkAction
+ * @param action AtkAction instance
* @param data additional action data (not used here)
*
* @return TRUE if action was triggered successfully, FALSE otherwise
}
/**
- * @brief Handle for action release
+ * @brief Handle for 'release' action
*
- * @param action an AtkAction
+ * @param action AtkAction instance
* @param data additional action data (not used here)
*
* @return TRUE if action was triggered successfully, FALSE otherwise
* @brief Macro upcasts an instance (obj) of a subclass to the EailFileselectorentry
* type
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_FILESELECTOR_ENTRY(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), \
EAIL_TYPE_FILESELECTOR_ENTRY, EailFileselectorEntry))
/**
* @brief Tests whether object (obj) is an instance of EailFileselectorentry class
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_IS_FILESELECTOR_ENTRY(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), \
EAIL_TYPE_FILESELECTOR_ENTRY))
/** @brief Definition of object structure for Atk EailEntry*/
struct _EailFileselectorEntry
{
- EailActionWidget parent;/**< @brief parent widget that is being extended */
+ EailActionWidget parent;/**< @brief Parent widget whose functionality is being extended */
};
atk_action_interface_init));
/**
- * @brief handler for event which is raised when flips visible data is changed
+ * @brief Handler for event which is raised when flip's visible data is changed
*
- * @param data passed to callback
- * @param obj object that raised event
+ * @param data data passed to callback
+ * @param obj Evas_Object that raised event
* @param event_info additional event info
*/
void
/**
* @brief EailFlip object initialization
*
- * @param obj EailFlip object
+ * @param obj AtkObject instance
* @param data user set additional initialization data
*/
static void
/**
* @brief Class destructor
*
- * @param object object instance
+ * @param object GObject instance
*/
static void
eail_flip_finalize(GObject *object)
}
/**
- * @brief Gets widget children
+ * @brief Gets widget's children
*
- * @param widget EailWidget object
+ * @param widget EailWidget instance
*
- * @return list of children, NULL if no children
+ * @return Eina_List representing the list of children,
+ * or NULL if widget has no children
*/
static Eina_List *
eail_flip_get_widget_children(EailWidget *widget)
/**
* @brief GObject type initialization function
*
- * @param klass EailFlip class
+ * @param klass EailFlipClass instance
*/
static void
eail_flip_class_init(EailFlipClass *klass)
*/
/**
- * @brief Implementation of get_n_actions from AtkAction interface
+ * @brief Gets the number of accessible actions available on the object
*
- * @param action EailFlip instance
- * @returns number of implemented actions
+ * If there are more than one, the first one is considered the "default" action of the object.
+ *
+ * Implementation of get_n_actions from AtkAction interface.
+ *
+ * @param action AtkAction instance
+ * @returns integer representing the number of implemented actions
*/
static int
eail_flip_n_actions_get(AtkAction *action)
}
/**
- * @brief Implementation of get_description from AtkAction interface
+ * @brief Gets the description string of the specified action
+ *
+ * Implementation of get_description from AtkAction interface.
*
- * @param action EailFlip instance
+ * @param action AtkAction instance
* @param i action index
*
- * @return action description
+ * @return string representing the specified action's description
*/
static const char*
eail_flip_description_get(AtkAction *action,
}
/**
- * @brief Implementation of set_descritpion from AtkAction interface
+ * @brief Sets a description of the specified action of the object
*
- * @param action EailFlip instance
+ * Implementation of set_description from AtkAction interface.
+ *
+ * @param action AtkAction instance
* @param i action index
- * @param description action description
+ * @param description action's description
*
* @return TRUE on success, FALSE otherwise
*/
}
/**
- * @brief Implementation of get_name from AtkAction interface
+ * @brief Gets the name string of the specified action
+ *
+ * Implementation of get_name from AtkAction interface.
*
- * @param action EailFlip instance
+ * @param action AtkAction instance
* @param i action index
*
- * @return action name
+ * @return string representing the specified action's name
*/
static const char*
eail_flip_action_name_get(AtkAction *action,
}
/**
- * @brief Implementation of do_action from AtkAction interface
+ * @brief Performs the specified action on the object
+ *
+ * Implementation of do_action from AtkAction interface.
*
- * @param action EailFlip instance
+ * @param action AtkAction instance
* @param i action index
*
* @return TRUE on success, FALSE otherwise
/**
* @brief AtkAction interface initializer
*
- * @param iface an AtkActionIface
+ * @param iface AtkActionIface instance
*/
static void
atk_action_interface_init(AtkActionIface *iface)
* @brief Macro upcasts an instance (obj) of a subclass to the EailFlip
* type
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_FLIP(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), \
EAIL_TYPE_FLIP, EailFlip))
/**
* @brief Tests whether object (obj) is an instance of EailFlip class
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_IS_FLIP(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), \
EAIL_TYPE_FLIP))
/** @brief Definition of object structure for Atk EailFlip*/
struct _EailFlip
{
- /** @brief Parent object that functionality is being extended*/
+ /** @brief Parent object whose functionality is being extended*/
EailWidget parent;
char *flip_description; /*!< @brief 'flip' action description*/
#include "eail_priv.h"
/**
- * @brief Number of max selections
+ * @brief Maximum number of selections
*/
#define FLIPSELECTOR_MAX_SELECTIONS 1
}
/**
- * @brief EailFlipselector initializer.
+ * @brief EailFlipselector initializer
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
* @param data initialization data
*/
static void
}
/**
- * @brief EailFlipselector finalizer.
+ * @brief EailFlipselector finalizer
+ *
* Frees memory assigned to object.
*
* @param object GObject instance
}
/**
- * @brief Gets obj items list.
+ * @brief Gets obj's items list
*
- * @param obj an EailFlipselector
- * @return list with obj items
+ * @param obj EailFlipselector instance
+ * @return Eina_List representing the list of obj's items
*/
static const Eina_List *
eail_flipselector_items_get(EailFlipselector *obj)
}
/**
- * @brief Gets reference to i-th child
+ * @brief Gets a reference to the i-th child of the accessible
*
- * The caller must unreference it when it is no longer needed
+ * The caller must unreference it when it is no longer needed.
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
* @param i child index
- * @return child reference
+ * @return AtkObject representing the i-th child of the accessible
*/
static AtkObject *
eail_flipselector_ref_child(AtkObject *obj,
}
/**
- * @brief Gets number of obj children
+ * @brief Gets the number of children of the accessible
*
- * @param obj an AtkObject
- * @return obj children number
+ * @param obj AtkObject instance
+ * @return integer representing the number children of the accessible
*/
static gint
eail_flipselector_get_n_children(AtkObject *obj)
}
/**
- * @brief EailFlipselector interface initializer.
+ * @brief EailFlipselector interface initializer
*
* @param flipselector EailFlipselector instance
*/
/**
- * @brief Get name of flipselector child
+ * @brief Gets the name of a flipselector's child
*
- * @param parent instance
- * @param item child instance
+ * @param parent EailItemParent instance
+ * @param item EailItem instance
*
- * @returns const gchar * representing name of the child
+ * @returns string representing the name of the child
*/
static const gchar *
eail_flipselector_item_name_get(EailItemParent *parent, EailItem *item)
}
/**
- * @brief Implementation of EailItemParent->is_content_get_supported callback
+ * @brief Checks if content get is supported
+ *
+ * Implementation of EailItemParent->is_content_get_supported callback.
*
- * @param parent an EailItemParent
- * @param item an EailItemParent
+ * @param parent EailItemParent instance
+ * @param item EailItem instance
* @returns FALSE as there is no content support
*/
gboolean
/**
* @brief EailItemParent interface initializer
*
- * @param iface an EailItemParentIface
+ * @param iface EailItemParentIface instance
*/
static void
eail_item_parent_interface_init(EailItemParentIface *iface)
/**
* @brief EailFlipselector class initializer
*
- * @param klass EailFlipselector class
+ * @param klass EailFlipselectorClass instance
*/
static void
eail_flipselector_class_init(EailFlipselectorClass *klass)
}
/**
- * @brief Selects i-th item.
+ * @brief Selects the i-th item of the accessible
*
- * @param selection an AtkSelection
+ * @param selection AtkSelection instance
* @param i item index
- * @return TRUE if item is selected, FALSE otherwise
+ * @return TRUE if item was successfully selected, FALSE otherwise
*/
static gboolean
eail_flipselector_add_selection(AtkSelection *selection,
}
/**
- * @brief Clears selections.
+ * @brief Clears selections
*
- * @param selection an AtkSelection
- * @return FALSE
+ * @param selection AtkSelection instance
+ * @return always FALSE
*/
static gboolean
eail_flipselector_clear_selection(AtkSelection *selection)
}
/**
- * @brief Gets the number of currently selected children.
+ * @brief Gets the number of currently selected children
*
- * @param selection AtkSelection
- * @return number of selected children
+ * @param selection AtkSelection instance
+ * @return integer representing the number of selected children
*/
static gint
eail_flipselector_get_selection_count(AtkSelection *selection)
}
/**
- * @brief Determines if i-th child is selected.
+ * @brief Determines if the i-th child of the accessible is selected
*
- * @param selection an AtkSelection
+ * @param selection AtkSelection instance
* @param i child index
- * @return TRUE if child is selected, FALSE otherwise
+ * @return TRUE if the i-th child is selected, FALSE otherwise
*/
static gboolean
eail_flipselector_is_child_selected(AtkSelection *selection,
}
/**
- * @brief Removes i-th selection.
+ * @brief Removes the i-th selection of the accessible
*
- * @param selection an AtkSelection
+ * @param selection AtkSelection instance
* @param i selection index
- * @return TRUE if selection is removed, FALSE otherwise
+ * @return TRUE if selection was successfully removed, FALSE otherwise
*/
static gboolean
eail_flipselector_remove_selection(AtkSelection *selection,
}
/**
- * @brief Selects all children.
+ * @brief Selects all children of the accessible
*
- * @param selection an AtkSelection
- * @returns FALSE
+ * @param selection AtkSelection instance
+ * @returns always FALSE
*/
static gboolean
eail_flipselector_select_all_selection(AtkSelection *selection)
}
/**
- * @brief AtkSelection interface initializer.
+ * @brief AtkSelection interface initializer
*
- * @param iface an AtkSelectionIface
+ * @param iface AtkSelectionIface instance
*/
static void atk_selection_interface_init(AtkSelectionIface *iface)
{
*/
/**
- * @brief Performs i-th action.
+ * @brief Performs the i-th action
*
- * @param action an AtkAction
+ * @param action AtkAction instance
* @param i action index
* @return TRUE on success, FALSE otherwise
*/
}
/**
- * @brief Gets number of actions available on the object.
+ * @brief Gets the number of actions available on the object
*
- * @param action an AtkAction
- * @return number of implemented actions
+ * @param action AtkAction instance
+ * @return integer representing the number of implemented actions
*/
static gint
eail_flipselector_action_get_n_actions(AtkAction *action)
}
/**
- * @brief Gets description for action with given index
- * @param action an AtkAction (EailFlipselector) object
+ * @brief Gets the description string of an action with the given index
+ *
+ * @param action AtkAction instance
* @param i index of action
*
- * @returns string representing action name or NULL if not found
+ * @returns string representing the specified action's description
+ * or NULL if one was not found
*/
static const gchar *
eail_flipselector_action_get_description(AtkAction *action,
}
/**
- * @brief Gets i-th action name.
+ * @brief Gets the name string of an action with the given index
*
- * @param action an AtkAction
+ * @param action AtkAction instance
* @param i action index
- * @return action description
+ * @return string representing the specified action's name
+ * or NULL if one was not found
*/
static const gchar *
eail_flipselector_action_get_name(AtkAction *action,
}
/**
- * @brief Sets i-th action description.
+ * @brief Sets the description of the specified action
*
- * @param action an AtkAction
- * @param i action number
- * @param desc action description
- * @return TRUE if description is set successfully, FALSE otherwise
+ * @param action AtkAction instance
+ * @param i action's number
+ * @param desc action's description
+ * @return TRUE if description was set successfully, FALSE otherwise
*/
static gboolean
eail_flipselector_action_set_description(AtkAction *action,
}
/**
- * @brief AtkAction interface initializer.
+ * @brief AtkAction interface initializer
*
- * @param iface an AtkActionIface
+ * @param iface AtkActionIface instance
*/
static void
atk_action_interface_init(AtkActionIface *iface)
* @brief Macro upcasts an instance (obj) of a subclass to the EailFlipselector
* type
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_FLIPSELECTOR(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), \
EAIL_TYPE_FLIPSELECTOR, EailFlipselector))
/**
* @brief Tests whether object (obj) is an instance of EailFlipselector class
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_IS_FLIPSELECTOR(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), \
EAIL_TYPE_FLIPSELECTOR))
/** @brief Definition of object structure for Atk EailFlipselector*/
struct _EailFlipselector
{
- EailWidget parent;/**< @brief widget that functionality is being extended*/
+ EailWidget parent;/**< @brief Parent widget whose functionality is being extended*/
char *next_description;/**< @brief 'next' action description string */
char *prev_description;/**< @brief 'prev' action description string */
/**
* @brief EailFrame initializer
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
* @param data initialization data
*/
static void
}
/**
- * @brief Gets widget children
+ * @brief Gets widget's children
*
- * @param widget an EailWidget
- * @return widget children list
+ * @param widget EailWidget instance
+ * @return Eina_List representing the list of widget's children
*/
static Eina_List *
eail_frame_get_widget_children(EailWidget *widget)
}
/**
- * @brief Gest obj name
+ * @brief Gets obj's name
*
- *
- *
- * @param obj an AtkObject
- * @return obj name
+ * @param obj AtkObject instance
+ * @return string representing obj's name
*/
static const gchar*
eail_frame_get_name(AtkObject *obj)
/**
* @brief EailFrame instance initializer
*
- * @param frame an EailFrame
+ * @param frame EailFrame instance
*/
static void
eail_frame_init(EailFrame *frame)
/**
* @brief EailFrame class initializer
*
- * @param klass an EailFrame class
+ * @param klass EailFrameClass instance
*/
static void
eail_frame_class_init(EailFrameClass *klass)
* @brief Macro upcasts an instance (obj) of a subclass to the EailFrame
* type
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_FRAME(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), \
EAIL_TYPE_FRAME, EailFrame))
/**
* @brief Tests whether object (obj) is an instance of EailFrame class
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_IS_FRAME(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), \
EAIL_TYPE_FRAME))
/** @brief Definition of object structure for Atk EailFrame*/
struct _EailFrame
{
- /** @brief Parent object that functionality is being extended*/
+ /** @brief Parent widget whose functionality is being extended*/
EailWidget parent;
};
/**
* @file eail_gengrid.c
- * @brief Implementation of gengrid widget
+ * @brief EailGengrid implementation
*/
#include <Elementary.h>
}
/**
- * @brief Initialize EailGengrid object
+ * @brief Initializes EailGengrid object
*
* @param obj EailGengrid instance
- * @param data user data passed to initialization
+ * @param data user data passed for initialization
*/
static void
eail_gengrid_initialize(AtkObject *obj, gpointer data)
}
/**
- * @brief Get list of created widgets
+ * @brief Gets the list of created widgets
*
* @param gengrid EailGengrid instance
*
- * @returns list of widgets elm_gengrid holds
+ * @returns Eina_List representing the list of widgets elm_gengrid holds
*/
static Eina_List *
eail_gengrid_items_get(EailGengrid *gengrid)
}
/**
- * @brief Get number of created widgets
+ * @brief Gets the number of created widgets
*
- * @param obj EailGengrid instance
+ * @param obj AtkObject instance
*
- * @returns number of created widgets
+ * @returns integer representing the number of created widgets
*/
static gint
eail_gengrid_n_items_get(AtkObject *obj)
}
/**
- * @brief Get reference to elm_gengrid child as AtkObject
+ * @brief Gets the reference to the specified elm_gengrid's child
*
- * @param obj EailGengrid instance
+ * @param obj AtkObject instance
* @param i child index
*
- * @returns reference to AtkObject
+ * @returns AtkObject representing the elm_gengrid's child
*/
static AtkObject *
eail_gengrid_ref_child(AtkObject *obj, gint i)
}
/**
- * @brief Implementation of ref_state_set from AtkObject
+ * @brief Gets a reference to the state set of the accessible
*
- * @param obj EailGengrid instance
+ * The caller must unreference it when it is no longer needed.
*
- * @returns reference to an state set of accessible
+ * Implementation of ref_state_set from AtkObject.
+ *
+ * @param obj AtkObject instance
+ *
+ * @returns AtkStateSet representing the state set of the accessible
*/
static AtkStateSet *
eail_gengrid_ref_state_set(AtkObject *obj)
}
/**
- * @brief Init EailGengrid object
+ * @brief Initializes EailGengrid object
*
* @param gengrid EailGengrid instance
*/
}
/**
- * @brief Init EailGengrid class
+ * @brief Initializes EailGengrid class
*
- * @param klass EailGengrid class
+ * @param klass EailGengridClass instance
*/
static void
eail_gengrid_class_init(EailGengridClass *klass)
}
/**
- * @brief Get name of elm_gengrid child
+ * @brief Gets the name of elm_gengrid child
*
- * @param parent EailGengrid instance
- * @param item EailGengrid child instance
+ * @param parent EailItemParent instance
+ * @param item EailItem child instance
*
- * @returns string representing item name
+ * @returns string representing the item's name
*/
static const gchar *
eail_gengrid_item_name_get(EailItemParent *parent, EailItem *item)
}
/**
- * @brief Get item index in parent object
+ * @brief Gets the item's index in parent object
*
- * @param parent EailGengrid instance
- * @param item EailGengrid child
+ * @param parent EailItemParent instance
+ * @param item EailItem child instance
*
- * @returns child index in parent object
+ * @returns integer representing the child's index in parent
*/
static int
eail_gengrid_item_index_in_parent_get(EailItemParent *parent, EailItem *item)
}
/**
- * @brief Get state set of EailGengrid item
+ * @brief Gets the state set of EailGengrid item
*
- * @param parent EailGengrid instance
- * @param item EailGengrid child instance
+ * @param parent EailItemParent instance
+ * @param item EailItem child instance
* @param state_set AtkStateSet to fill
*
- * @returns state set of EailGengrid child
+ * @returns AtkStateSet representing the state set of the child
*/
static AtkStateSet *
eail_gengrid_ref_item_state_set(EailItemParent *parent,
}
/**
- * @brief Grabs focus on EailGengrid item
+ * @brief Grabs focus of EailGengrid item
*
* @param parent EailGengrid instance
* @param item EailGengrid child instance
}
/**
- * @brief Implementation of get_extents from AtkComponent for EailGengrid child
+ * @brief Gets the rectangle which gives the extent of the component
+ *
+ * Implementation of get_extents from AtkComponent for EailGengrid child.
*
* @param parent EailGengrid instance
* @param item EailGengrid child instance
- * @param x address to store x coordinate
- * @param y address to store y coordinate
- * @param width address to store width
- * @param height address to store height
+ * @param [out] x x coordinate
+ * @param [out] y coordinate
+ * @param [out] width width of the rectangle
+ * @param [out] height height of the rectangle
* @param coord_type specifies whether the coordinates are relative to the screen or to the components top level window
*/
static void
}
/**
- * @brief Implementation of EailItemParent->get_actions_supported callback
+ * @brief Gets supported actions
*
- * @param parent an EailItemParent
- * @param item an EailItem
- * @returns enum representing supported actions
+ * Implementation of EailItemParent->get_actions_supported callback.
+ *
+ * @param parent EailItemParent instance
+ * @param item EailItem instance
+ * @returns implementation representing supported actions
*/
static gint
eail_gengrid_get_actions_supported(EailItemParent *parent,
}
/**
- * @brief EailItemParent iterface initialization
+ * @brief EailItemParent interface initialization
*
- * @param iface EailItemParentIface iterface instace
+ * @param iface EailItemParentIface instance
*/
static void
eail_item_parent_interface_init(EailItemParentIface *iface)
}
/**
- * @brief Helper function to get rows and columns count
+ * @brief Helper function for getting rows and columns count
*
* @param object elm_gengrid instance
- * @param rows address to store rows count
- * @param columns address to store columns count
+ * @param [out] rows rows count
+ * @param [out] columns columns count
*/
static void
_get_n_rows_columns(const Evas_Object *object,
/**
- * @brief Implementation of get_n_rows from AtkTable
+ * @brief Gets the number of rows in the table
+ *
+ * Implementation of get_n_rows from AtkTable.
*
- * @param table EailGengrid instance
+ * @param table AtkTable instance
*
- * @returns number of rows
+ * @returns integer representing the number of rows
*/
static gint
eail_gengrid_n_rows_get(AtkTable *table)
}
/**
- * @brief Implementation of get_n_columns from AtkTable
+ * @brief Gets the number of columns in the table
+ *
+ * Implementation of get_n_columns from AtkTable.
*
- * @param table EailGengrid instance
+ * @param table AtkTable instance
*
- * @returns number of columns
+ * @returns integer representing the number of columns
*/
static gint
eail_gengrid_n_columns_get(AtkTable *table)
}
/**
- * @brief Implementation of get_index_at from AtkTable
+ * @brief Gets a gint representing the index at the specified row and column
*
- * @param table EailGengrid instance
+ * Implementation of get_index_at from AtkTable.
+ *
+ * @param table AtkTable instance
* @param row number of row in table
* @param column number of column in table
*
- * @returns index at specified position
+ * @returns integer representing the index of the specified position
*/
static gint
eail_gengrid_index_at_get(AtkTable *table, gint row, gint column)
}
/**
- * @brief Implementation of ref_at from AtkTable
+ * @brief Get a reference to the table cell at row, column
+ *
+ * Implementation of ref_at from AtkTable.
*
- * @param table EailGengrid instance
+ * @param table AtkTable instance
* @param row number of row in table
* @param column number of column in table
*
- * @returns referred child object
+ * @returns AtkObject representing the child object
*/
static AtkObject *
eail_gengrid_ref_at(AtkTable *table, gint row, gint column)
}
/**
- * @brief Helper function to get object position in table at given index
+ * @brief Helper function for getting object's position in table at given index
*
- * @param widget elm_gengrid widget
- * @param row address to store row number
- * @param column address to store column number
+ * @param widget Evas_Object instance
+ * @param [out] row row number
+ * @param [out] column column number
* @param index index of child item
*/
static void
}
/**
- * @brief Implementation of get_column_at_index from AtkTable
+ * @brief Gets an integer representing the column at the specified index
*
- * @param table EailGengrid instance
- * @param index number of child index
+ * Implementation of get_column_at_index from AtkTable.
*
- * @returns column number in table
+ * @param table AtkTable instance
+ * @param index child index
+ *
+ * @returns integer representing the column number in table
*/
static gint
eail_gengrid_column_at_index_get(AtkTable *table, gint index)
}
/**
- * @brief Implementation of get_row_at_index from AtkTable
+ * @brief Gets a gint representing the row at the specified index
+ *
+ * Implementation of get_row_at_index from AtkTable.
*
- * @param table EailGengrid instance
- * @param index index of child
+ * @param table AtkTable instance
+ * @param index child index
*
- * @returns row number in table
+ * @returns integer representing the row number in table
*/
static gint
eail_gengrid_row_at_index_get(AtkTable *table, gint index)
}
/**
- * @brief Implementation of is_selected from AtkTable
+ * @brief Gets a boolean value indicating whether the accessible object
+ * at the specified row and column is selected
*
- * @param table EailGengrid instance
- * @param row row number
- * @param column column number
+ * Implementation of is_selected from AtkTable.
*
- * @returns TRUE if selected FALSE otherwise
+ * @param table AtkTable instance
+ * @param row row's number
+ * @param column column's number
+ *
+ * @returns TRUE if selected, FALSE otherwise
*/
static gboolean
eail_gengrid_is_selected(AtkTable *table, gint row, gint column)
}
/**
- * @brief Implementation of is_row_selected from AtkTable interface
+ * @brief Gets a boolean value indicating whether the specified row is selected
*
- * @param table EailGengrid instance
+ * Implementation of is_row_selected from AtkTable interface.
+ *
+ * @param table AtkTable instance
* @param row number of row in table
*
* @returns TRUE if selected, FALSE otherwise
}
/**
- * @brief Implementation of get_selected_rows from AtkTable interface
+ * @brief Gets the selected rows of the table by initializing selected
+ * with the selected row numbers
+ *
+ * This array should be freed by the caller.
+ *
+ * Implementation of get_selected_rows from AtkTable interface.
*
- * @param table EailGengrid instace
- * @param selected address to gint* for store selected rows number
+ * @param table AtkTable instance
+ * @param [out] selected selected rows number
*
- * @returns selected rows count
+ * @returns integer representing the selected rows count
*/
static gint
eail_gengrid_selected_rows_get(AtkTable *table, gint **selected)
}
/**
- * @brief Helper function to set row selection
+ * @brief Helper function for setting row selection
*
- * @param table EailGengrid instance
+ * @param table AtkTable instance
* @param row row number
- * @param selection EINA_TRUE on selection, EINA_FALSE on remove selection
+ * @param selection EINA_TRUE for selection, EINA_FALSE for removing selection
*/
static void
_set_row_selection(AtkTable *table, int row, Eina_Bool selection)
}
/**
- * @brief Implementation of add_row_selection from AtkTable
+ * @brief Adds the specified row to the selection
*
- * @param table EailGengrid instance
+ * Implementation of add_row_selection from AtkTable.
+ *
+ * @param table AtkTable instance
* @param row row number in table
*
* @returns TRUE on success, FALSE otherwise
}
/**
- * @brief Implementation of remove_row_selection from AtkTable interface
+ * @brief Removes the specified row from the selection
+ *
+ * Implementation of remove_row_selection from AtkTable interface.
*
- * @param table EailGengrid instance
+ * @param table AtkTable instance
* @param row number of row in table
*
* @returns TRUE on success, FALSE otherwise
}
/**
- * @brief Implementation of is_column_selected from AtkTable interface
+ * @brief Gets a boolean value indicating whether the specified column is selected
*
- * @param table EailGengrid implementation
+ * Implementation of is_column_selected from AtkTable interface.
+ *
+ * @param table AtkTable implementation
* @param column number of column in table
*
* @returns TRUE on selection, FALSE otherwise
}
/**
- * @brief Helper function to set column selection in elm_gengrid
+ * @brief Helper function for setting column selection in elm_gengrid
*
- * @param table EailGengrid instance
+ * @param table AtkTable instance
* @param column number of column in table
- * @param selection EINA_TRUE on selection, EINA_FALSE otherwise
+ * @param selection EINA_TRUE for selection, EINA_FALSE otherwise
*/
static void
_set_column_selection(AtkTable *table, int column, Eina_Bool selection)
}
/**
- * @brief Implementation of add_column_selection from AtkTable interface
+ * @brief Adds the specified column to the selection
+ *
+ * Implementation of add_column_selection from AtkTable interface.
*
- * @param table EailGengrid instance
+ * @param table AtkTable instance
* @param column number of column in table
*
* @returns TRUE on success, FALSE otherwise
}
/**
- * @brief Implementation remove_column_selection from AtkTable
+ * @brief Removes the specified column from the selection
+ *
+ * Implementation of remove_column_selection from AtkTable.
*
- * @param table EailGengrid instance
+ * @param table AtkTable instance
* @param column column number in table
*
* @returns TRUE on success, FALSE otherwise
/**
* @brief AtkTable interface initialization
*
- * @param iface EailGengrid instance
+ * @param iface AtkTableIface instance
*/
static void
atk_table_interface_init(AtkTableIface *iface)
}
/**
- * @brief Implementation of add_selection from AtkSelection interface
+ * @brief Adds the specified accessible child of the object to the object's selection
*
- * @param selection EailGengrid instance
+ * Implementation of add_selection from AtkSelection interface.
+ *
+ * @param selection AtkSelection instance
* @param i index of child to select
*
* @returns TRUE on success, FALSE otherwise
}
/**
- * @brief Implementation of clear_selection from AtkSelection
+ * @brief Clears the selection in the object so that no children in the object are selected
+ *
+ * Implementation of clear_selection from AtkSelection.
*
- * @param selection EailGengrid instance
+ * @param selection AtkSelection instance
*
- * @returns TRUE on success FALSE otherwise
+ * @returns TRUE on success, FALSE otherwise
*/
static gboolean
eail_gengrid_selection_clear(AtkSelection *selection)
/**
- * @brief Implementation of ref_selection from AtkSelection interface
+ * @brief Gets a reference to the accessible object representing the specified
+ * selected child of the object
+ *
+ * Note: callers should not rely on NULL
+ * or on a zero value for indication of whether AtkSelectionIface is
+ * implemented, they should use type checking/interface checking macros
+ * or the atk_get_accessible_value() convenience method.
+ *
+ * Implementation of ref_selection from AtkSelection interface.
*
- * @param selection EailGengrid instance
+ * @param selection AtkSelection instance
* @param i index of selected child
*
- * @returns reffered selected object
+ * @returns AtkObject representing the selected object
*/
static AtkObject *
eail_gengrid_selection_ref(AtkSelection *selection, gint i)
}
/**
- * @brief Implementation of get_selection_count from AtkSelection interface
+ * @brief Gets the number of accessible children currently selected.
+ *
+ * Note: callers should not rely on NULL or on a zero value
+ * for indication of whether AtkSelectionIface is implemented,
+ * they should use type checking/interface checking macros or
+ * the atk_get_accessible_value() convenience method.
+ *
+ * Implementation of get_selection_count from AtkSelection interface.
*
- * @param selection EailGengrid instance
+ * @param selection AtkSelection instance
*
- * @returns number of selected items
+ * @returns integer representing the number of selected items
*/
static gint
eail_gengrid_selection_count_get(AtkSelection *selection)
}
/**
- * @brief Implementation of is_child_selected from AtkSelection interface
+ * @brief Determines if the current child of this object is selected.
*
- * @param selection EailGengrid instance
+ * Note: callers should not rely on NULL or on a zero value for
+ * indication of whether AtkSelectionIface is implemented, they
+ * should use type checking/interface checking macros or
+ * the atk_get_accessible_value() convenience method.
+ *
+ * Implementation of is_child_selected from AtkSelection interface.
+ *
+ * @param selection AtkSelection instance
* @param i index of child
*
- * @returns TRUE on selction, FALSE otherwise
+ * @returns TRUE on selection, FALSE otherwise
*/
static gboolean
eail_gengrid_selection_is_child_selected(AtkSelection *selection, int i)
}
/**
- * @brief Implementation of remove_selection from AtkSelection
+ * @brief Removes the specified child of the object from the object's selection
*
- * @param selection EailGengrid instance
+ * Implementation of remove_selection from AtkSelection.
+ *
+ * @param selection AtkSelection instance
* @param i index of selected child
*
* @returns TRUE on success, FALSE otherwise
}
/**
- * @brief Implementation of select_all from AtkSelection interface
+ * @brief Causes every child of the object to be selected if the object supports multiple selections
+ *
+ * Implementation of select_all from AtkSelection interface.
*
- * @param selection EailGengrid instance
+ * @param selection AtkSelection instance
*
* @return TRUE on success, FALSE otherwise
*/
/**
* @brief AtkSelection interface initialization
*
- * @param iface EailGengrid instance
+ * @param iface AtkSelectionIface instance
*/
static void
atk_selection_interface_init(AtkSelectionIface *iface)
* @brief Macro upcasts an instance (obj) of a subclass to the EailGengrid
* type
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_GENGRID(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), \
EAIL_TYPE_GENGRID, EailGengrid))
/**
* @brief Tests whether object (obj) is an instance of EailGengrid class
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_IS_GENGRID(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), \
EAIL_TYPE_GENGRID))
/** @brief Definition of object structure for Atk EailGengrid*/
struct _EailGengrid
{
- /** @brief Parent object that functionality is being extended*/
+ /** @brief Parent widget whose functionality is being extended*/
EailWidget parent;
};
/**
* @file eail_genlist.c
- * @brief Implementation of genlist widget
+ * @brief EailGenlist implementation
*/
#include <Eina.h>
*/
/**
- * @brief Handler for realized event, used to notify about genlist content
- * changes
+ * @brief Handler for realized event
+ *
+ * Notifies about genlist's content changes.
*
* @param data passed to callback
- * @param obj object that raised event
+ * @param obj Evas_Object that raised event
* @param event_info additional event info (item is passed here)
*/
void
/**
* @brief Initializer for AtkObjectClass
- * @param obj an AtkObject
+ * @param obj AtkObject instance
* @param data initialization data
*/
static void
* @brief Prepares Eina_List filled with Elm_Object_Item* objects
* representing items in the list
*
- * @param genlist an EailGenlist
+ * Call eina_list_free on the returned list when results processing has been finished.
*
- * @return filled list with list items. Call eina_list_free on that list when
- * results processing has been finished
+ * @param genlist EailGenlist instance
+ *
+ * @return Eina_List representing the list of list's items
*/
static Eina_List *
eail_genlist_get_items(EailGenlist *genlist)
}
/**
- * @brief Implementation AtkObject->get_n_children callback
+ * @brief Gets the number of accessible children of the accessible
*
- * ATK doc says:\n
- * Gets the number of accessible children of the accessible.
+ * Implementation of AtkObject->get_n_children callback.
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*
- * @returns an integer representing the number of accessible children of
+ * @returns integer representing the number of accessible children of
* the accessible
*/
static gint
}
/**
- * @brief Implementation AtkObject->ref_child callback
+ * @brief Gets a reference to the specified accessible child of the object.
+ *
+ * The accessible children are 0-based so the first accessible child is
+ * at index 0, the second at index 1 and so on.
*
- * ATK doc says:\n
- * Gets a reference to the specified accessible child of the object. The
- * accessible children are 0-based so the first accessible child is at index 0,
- * the second at index 1 and so on.
+ * Implementation of AtkObject->ref_child callback.
*
- * @param obj an AtkObject
- * @param i child index
+ * @param obj AtkObject instance
+ * @param i child's index
*
- * @returns an AtkObject representing the specified accessible child of the
- * accessible.
+ * @returns AtkObject representing the specified accessible child of the
+ * accessible
*/
static AtkObject *
eail_genlist_ref_child(AtkObject *obj, gint i)
}
/**
- * @brief Implementation AtkObject->ref_state_set callback
+ * @brief Gets a reference to the state set of the accessible
+ *
+ * The caller must unreference it when it is no longer needed.
*
- * ATK doc says:\n
- * Gets a reference to the state set of the accessible; the caller must
- * unreference it when it is no longer needed.
+ * Implementation of AtkObject->ref_state_set callback.
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*
- * @returns reference to an AtkStateSet which is the state set of the
+ * @returns AtkStateSet representing the state set of the
* accessible
*/
static AtkStateSet *
/**
* @brief Initializer for GObject EailList instance
*
- * @param genlist an EailGenlist
+ * @param genlist EailGenlist instance
*/
static void
eail_genlist_init(EailGenlist *genlist)
}
/**
- * @brief Initializer for GObject class (defines callbacks for base AtkObject)
+ * @brief Initializer for GObject class
*
- * @param klass an EailGenlistClass
+ * Defines callbacks for base AtkObject.
+ *
+ * @param klass EailGenlistClass instance
*/
static void
eail_genlist_class_init(EailGenlistClass *klass)
*/
/**
- * @brief Gets name of EailItem
+ * @brief Gets the name of EailItem
*
- * Implementation of EailItemParent->get_name callback
+ * Implementation of EailItemParent->get_name callback.
*
- * @param parent an EailItemParent
- * @param item an EailItem
+ * @param parent EailItemParent instance
+ * @param item EailItem instance
*
- * @returns a character string representing the accessible description of
- * the item.
+ * @returns character string representing the accessible name of
+ * the item
*/
static const gchar *
eail_genlist_get_item_name(EailItemParent *parent,
/**
* @brief Gets index of element in parent object
*
- * Implementation of EailItemParent->get_item_index_in_parent
+ * Implementation of EailItemParent->get_item_index_in_parent.
*
- * @param parent an EailItemParent
- * @param item an EailItem
+ * @param parent EailItemParent instance
+ * @param item EailItem instance
*
- * @returns an integer which is the index of the accessible in its parent
+ * @returns integer representing the index of the accessible in its parent
*/
static gint
eail_genlist_get_item_index_in_parent(EailItemParent *parent,
}
/**
- * @brief Implementation EailItemParent->ref_state_set callback
+ * @brief Gets a reference to the state set of the accessible
+ *
+ * The caller must unreference it when it is no longer needed.
*
- * ATK doc says:\n
- * Gets a reference to the state set of the accessible; the caller must
- * unreference it when it is no longer needed.
+ * Implementation EailItemParent->ref_state_set callback.
*
* @param parent object that holds EailItem in its content
- * @param item an EailItem object
- * @param state_set current AtkStateSet with some values
+ * @param item EailItem object
+ * @param state_set current state set
*
- * @returns reference to an AtkStateSet for given EailItem
+ * @returns AtkStateSet representing the state set of the accessible
*/
static AtkStateSet *
eail_genlist_ref_item_state_set(EailItemParent *parent,
}
/**
- * @brief Implementation of EailItemParent->grab_item_focus callback
+ * @brief Grabs focus of item
+ *
+ * Implementation of EailItemParent->grab_item_focus callback.
*
* @param parent object that holds EailItem in its content
- * @param item an EailItem object
+ * @param item EailItem instance
*
* @returns TRUE if operation was successfull, FALSE otherwise
*/
}
/**
- * @brief Gets the rectangle which gives the extent of the component.
+ * @brief Gets the rectangle which gives the extent of the component
+ *
+ * Implementation of get_extents from AtkComponent.
*
* @param parent object that holds EailItem in its content
- * @param item an EailItem object
- * @param x address of gint to put x coordinate
- * @param y address of gint to put y coordinate
- * @param width ddress of gint to put width
- * @param height address of gint to put height
+ * @param item EailItem object instance
+ * @param [out] x x coordinate
+ * @param [out] y y coordinate
+ * @param [out] width width of the rectangle
+ * @param [out] height height of the rectangle
* @param coord_type specifies whether the coordinates are relative to the
* screen or to the components top level window
*/
}
/**
- * @brief Implementation of EailItemParent->get_actions_supported callback
+ * @brief Gets supported actions
*
- * @param parent an EailItemParent
- * @param item an EailItem
- * @returns enum representing supported actions
+ * Implementation of EailItemParent->get_actions_supported callback.
+ *
+ * @param parent EailItemParent instance
+ * @param item EailItem instance
+ * @returns integer representing supported actions
*/
static gint
eail_genlist_get_actions_supported(EailItemParent *parent,
/**
* @brief Initialization of EailItemParentIface callbacks
*
- * @param iface an EailItemParentIface
+ * @param iface EailItemParentIface instance
*/
static void
eail_item_parent_interface_init(EailItemParentIface *iface)
*/
/**
- * @brief Implementation of AtkSelection->add_selection callback
+ * @brief Adds the specified accessible child of the object to the object's selection
*
- * As described in ATK doc:\n
- * Adds the specified accessible child of the object to the object's selection.
+ * Implementation of AtkSelection->add_selection callback.
*
- * @param selection an AtkSelection
+ * @param selection AtkSelection instance
* @param i selection index
*
- * @returns TRUE if operation ended successfully, FALSE otherwise
+ * @returns TRUE if operation was successfull, FALSE otherwise
*/
static gboolean
eail_genlist_add_selection(AtkSelection *selection,
}
/**
- * @brief Implementation of AtkSelection->ref_selection callback
+ * @brief Gets a reference to the accessible object representing the specified selected
+ * child of the object.
*
- * As described in ATK doc:\n
- * Gets a reference to the accessible object representing the specified selected
- * child of the object. Note: callers should not rely on NULL or on a zero value
+ * Note: callers should not rely on NULL or on a zero value
* for indication of whether AtkSelectionIface is implemented, they should use
* type checking/interface checking macros or the atk_get_accessible_value()
* convenience method.
*
- * @param selection an AtkSelection
+ * Implementation of AtkSelection->ref_selection callback.
+ *
+ * @param selection AtkSelection instance
* @param i selection index
*
- * @returns an AtkObject representing the selected accessible , or NULL if
+ * @returns AtkObject representing the selected accessible or NULL if
* selection does not implement this interface
*/
static AtkObject *
}
/**
- * @brief Implementation of AtkSelection->get_selection_count callback
+ * @brief Gets the number of accessible children currently selected.
*
- * As described in ATK doc:\n
- * Gets the number of accessible children currently selected. Note: callers
- * should not rely on NULL or on a zero value for indication of whether
+ * Note: callers should not rely on NULL or on a zero value for indication of whether
* AtkSelectionIface is implemented, they should use type checking/interface
* checking macros or the atk_get_accessible_value() convenience method.
*
- * @param selection an AtkSelection
+ * Implementation of AtkSelection->get_selection_count callback.
+ *
+ * @param selection AtkSelection instance
*
- * @returns gint representing number of selected elements
+ * @returns integer representing the number of selected children
*/
static gint
eail_genlist_get_selection_count(AtkSelection *selection)
}
/**
- * @brief Implementation of AtkSelection->is_child_selected callback
+ * @brief Determines if the current child of this object is selected.
*
- * As described in ATK doc:\n
- * Determines if the current child of this object is selected Note: callers
- * should not rely on NULL or on a zero value for indication of whether
+ * Note: callers should not rely on NULL or on a zero value for indication of whether
* AtkSelectionIface is implemented, they should use type checking/interface
* checking macros or the atk_get_accessible_value() convenience method.
*
- * @param selection an AtkSelection
+ * Implementation of AtkSelection->is_child_selected callback.
+ *
+ * @param selection AtkSelection instance
* @param i index of child
*
- * @returns a gboolean representing the specified child is selected, or 0 if
- * selection does not implement this interface.
+ * @returns gboolean representing whether the specified child is selected, or 0 if
+ * selection does not implement this interface
*/
static gboolean
eail_genlist_is_child_selected(AtkSelection *selection,
}
/**
- * @brief Implementation of AtkSelection->remove_selection callback
+ * @brief Removes the specified child of the object from the object's selection
*
- * As described in ATK doc:\n
- * Removes the specified child of the object from the object's selection.
+ * Implementation of AtkSelection->remove_selection callback.
*
- * @param selection an AtkSelection
+ * @param selection AtkSelection instance
* @param i index of child
*
- * @returns TRUE if success, FALSE otherwise.
+ * @returns TRUE on success, FALSE otherwise
*/
static gboolean
eail_genlist_remove_selection(AtkSelection *selection,
}
/**
- * @brief Helper function that selects/unselects all items in the list depending
+ * @brief Helper function for selecting/unselecting all items in the list depending
* on "selected" param value
*
- * @param selection an AtkSelection
+ * @param selection AtkSelection instance
* @param selected selected state (TRUE means selected)
*
- * @returns TRUE if success, FALSE otherwise.
+ * @returns TRUE on success, FALSE otherwise
*/
static gboolean
eail_genlist_mark_all_selected_state(AtkSelection *selection,
}
/**
- * @brief Implementation of AtkSelection->select_all_selection callback
+ * @brief Causes every child of the object to be selected if the object supports
+ * multiple selections
*
- * As described in ATK doc:\n
- * Causes every child of the object to be selected if the object supports
- * multiple selections.
+ * Implementation of AtkSelection->select_all_selection callback.
*
- * @param selection an AtkSelection
+ * @param selection AtkSelection instance
*
- * @returns TRUE if success, FALSE otherwise.
+ * @returns TRUE on success, FALSE otherwise
*/
static gboolean
eail_genlist_select_all_selection(AtkSelection *selection)
}
/**
- * @brief Implementation of AtkSelection->clear_selection callback
+ * @brief Clears the selection in the object so that no children in the object are
+ * selected
*
- * As described in ATK doc:\n
- * Clears the selection in the object so that no children in the object are
- * selected.
+ * Implementation of AtkSelection->clear_selection callback.
*
- * @param selection an AtkSelection
+ * @param selection AtkSelection instance
*
- * @returns TRUE if success, FALSE otherwise.
+ * @returns TRUE on success, FALSE otherwise
*/
static gboolean
eail_genlist_clear_selection(AtkSelection *selection)
/**
* @brief Initializer of AtkSelectionIface interface
*
- * @param iface an AtkSelectionIface
+ * @param iface AtkSelectionIface instance
*/
static void atk_selection_interface_init(AtkSelectionIface *iface)
{
* @brief Macro upcasts an instance (obj) of a subclass to the EailGenlist
* type
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_GENLIST(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), \
EAIL_TYPE_GENLIST, EailGenlist))
/**
* @brief Tests whether object (obj) is an instance of EailGenlist class
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_IS_GENLIST(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), \
EAIL_TYPE_GENLIST))
/** @brief Definition of object structure for Atk EailGenlist*/
struct _EailGenlist
{
- /** @brief Parent object that functionality is being extended*/
+ /** @brief Parent widget whose functionality is being extended*/
EailScrollableWidget parent;
};
/**
* @brief EailGlview initializer.
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
* @param data initialization data
*/
static void
/**
* @brief EailGlview interface initializer.
*
- * @param glview an EailGlview
+ * @param glview EailGlview instance
* */
static void
eail_glview_init(EailGlview *glview)
/**
* @brief EailGlview class initializer.
*
- * @param klass EailGlview class
+ * @param klass EailGlviewClass instance
*/
static void
eail_glview_class_init(EailGlviewClass *klass)
* @brief Macro upcasts an instance (obj) of a subclass to the EailGlview
* type
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_GLVIEW(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), \
EAIL_TYPE_GLVIEW, EailGlview))
/**
* @brief Tests whether object (obj) is an instance of EailGlview class
*
- * @param obj an AtkObject
+ * @param obj aAtkObject instance
*/
#define EAIL_IS_GLVIEW(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), \
EAIL_TYPE_GLVIEW))
/** @brief Definition of object structure for Atk EailGlview*/
struct _EailGlview
{
- /** @brief Parent object that functionality is being extended*/
+ /** @brief Parent widget whose functionality is being extended*/
EailWidget parent;
};
/**
* @file eail_grid.c
- * @brief Implementation of grid widget
+ * @brief EailGrid implementation
*/
#include <Elementary.h>
G_DEFINE_TYPE(EailGrid, eail_grid, EAIL_TYPE_WIDGET);
/**
- * @brief Implementation of eail_widget_get_widget_children callback from
- * EailWidget
+ * @brief Gets EvasObject from EailWidget.
*
- * @param widget an EailWidget
+ * Implementation of eail_widget_get_widget_children callback from
+ * EailWidget.
+ *
+ * @param widget EailWidget instance
*
* @returns Eina_List filled with Evas_Object* objects contained in grid widget
*/
/**
* @brief Initializer for AtkObjectClass
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
* @param data initialization data
*/
static void
/**
* @brief Initializer for GObject class
*
- * @param grid an EailGrid
+ * @param grid EailGrid instance
*/
static void
eail_grid_init(EailGrid *grid)
}
/**
- * @brief Initializer for GObject grid class (defines callbacks for base
- * AtkObject)
+ * @brief Initializer for GObject grid class
+ *
+ * Defines callbacks for base AtkObject.
*
- * @param klass an EailGridClass
+ * @param klass EailGridClass class
*/
static void
eail_grid_class_init(EailGridClass *klass)
* @brief Macro upcasts an instance (obj) of a subclass to the EailGrid
* type
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_GRID(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), \
EAIL_TYPE_GRID, EailGrid))
/**
* @brief Tests whether object (obj) is an instance of EailGrid class
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_IS_GRID(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), \
EAIL_TYPE_GRID))
/** @brief Definition of object structure for Atk EailGrid*/
struct _EailGrid
{
- /** @brief Parent object that functionality is being extended*/
+ /** @brief Parent widget whose functionality is being extended*/
EailWidget parent;
};
/**
* @brief EailHover initializer
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
* @param data initialization data
*/
static void
/**
* @brief EailHover finalizer.
*
- * Destroys object and allocated resources.
+ * Destroys the object and allocated resources.
*
- * @param obj a GObject
+ * @param obj GObject instance
*/
static void
eail_hover_finalize(GObject *obj)
/**
* @brief EailHover instance initializer
*
- * @param hover an EailHover
+ * @param hover EailHover instance
*/
static void
eail_hover_init(EailHover *hover)
/**
* @brief EailHover class initializer.
*
- * @param klass an EailHoverClass
+ * @param klass EailHoverClass instance
*/
static void
eail_hover_class_init(EailHoverClass *klass)
}
/**
- * @brief Performs i-th action.
+ * @brief Performs the specified action on the object.
*
- * @param action an AtkAction
- * @param i the action index corresponding to the action to be performed
+ * @param action AtkAction instance
+ * @param i index of an action to be performed
* @return TRUE on success, FALSE otherwise
*/
static gboolean
/**
* @brief Gets number of actions available on the object.
*
- * @param action an AtkAction
- * @return actions number
+ * If there are more than one, the first one is considered the "default" action of the object.
+ *
+ * Implementation of get_n_actions from AtkAction interface.
+ *
+ * @param action AtkAction instance
+ * @return integer containing the number of implemented actions
*/
static gint
eail_hover_action_get_n_actions(AtkAction *action)
}
/**
- * @brief Gets i-th action description.
+ * @brief Gets the description of the specified action of the object.
+ *
+ * Implementation of get_description from AtkAction interface.
*
- * @param action an AtkAction
+ * @param action AtkAction instance
* @param i action number
- * @return action description string
+ * @return string representing the description of the specified action
*/
static const gchar *
eail_hover_action_get_description(AtkAction *action,
}
/**
- * @brief Gets i-th action name.
+ * @brief Gets the name of the specified action of the object.
*
- * @param action an AtkAction
+ * Implementation of get_name from AtkAction interface.
+ *
+ * @param action AtkAction instance
* @param i action number
- * @return action description string
+ * @return string containing the name of the specified action
*/
static const gchar *
eail_hover_action_get_name(AtkAction *action,
}
/**
- * @brief Sets i-th action description.
+ * @brief Sets a description of the specified action of the object.
+ *
+ * Implementation of set_description from AtkAction interface.
*
- * @param action an AtkAction
+ * @param action AtkAction instance
* @param i action number
* @param desc action description
- * @return TRUE if description is set successfully, FALSE otherwise
+ * @return TRUE if description was set successfully, FALSE otherwise
*/
static gboolean
eail_hover_action_set_description(AtkAction *action,
/**
* @brief AtkAction interface initializer
*
- * @param iface an AtkActionIface
+ * @param iface AtkActionIface instance
*/
static void
atk_action_interface_init(AtkActionIface *iface)
* @brief Macro upcasts an instance (obj) of a subclass to the EailHover
* type
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_HOVER(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), \
EAIL_TYPE_HOVER, EailHover))
/**
* @brief Tests whether object (obj) is an instance of EailHover class
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_IS_HOVER(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), \
EAIL_TYPE_HOVER))
/** @brief Definition of object structure for Atk EailHover*/
struct _EailHover
{
- EailWidget parent;/**< @brief widget that functionality is being extended*/
+ EailWidget parent;/**< @brief Parent widget whose functionality is being extended*/
char *click_description;/**< @brief 'click' action description string */
};
/**
* @brief EailHoverser initializer
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
* @param data initialization data
*/
static void
}
/**
- * @brief Gets state set of the accessible.
+ * @brief Gets the state set of the accessible.
*
* The caller must unreference it when it is no longer needed.
*
* @param accessible EailHoversel instance
- * @return EailHoversel state set
+ * @return AtkStateSet containing the state set of the accessible
*/
static AtkStateSet*
eail_hoversel_ref_state_set(AtkObject *accessible)
}
/**
- * @brief Gets number of obj children
+ * @brief Gets the number of accessible children of obj
*
- * @param obj an AtkObject
- * @return obj children number
+ * @param obj AtkObject instance
+ * @return integer containing the number of obj's children
*/
static gint
eail_hoversel_get_n_children(AtkObject *obj)
}
/**
- * @brief Gets reference to i-th child
+ * @brief Gets a reference to the specified accessible child of the object.
*
- * The caller must unreference it when it is no longer needed
+ * The accessible children are 0-based so the first accessible child is at index 0, the second at index 1 and so on.
*
- * @param obj an AtkObject
+ * Implementation of ref_child from AtkObject interface.
+ *
+ * The caller must unreference it when it is no longer needed.
+ *
+ * @param obj AtkObject instance
* @param i child index
- * @return child reference
+ * @return AtkObject containing the reference to the specified accessible child
*/
static AtkObject *
eail_hoversel_ref_child(AtkObject *obj,
/**
* @brief EailHoversel class initializer.
*
- * @param klass EailHoversel class
+ * @param klass EailHoverselClass instance
*/
static void
eail_hoversel_class_init(EailHoverselClass *klass)
/**
* @brief AtkAction interface initializer.
*
- * @param iface EailHoversel object
+ * @param iface EailHoversel instance
*/
static void
atk_action_interface_init(AtkActionIface *iface)
}
/**
- * @brief Gets i-th action description.
+ * @brief Gets the description of the specified action of the object.
+ *
+ * Implementation of get_description from AtkAction interface.
*
* @param action EailHoversel instance
* @param i action index
- * @return action description
+ * @return string representing the description of the specified action
*/
static const char*
eail_hoversel_description_get(AtkAction *action,
}
/**
- * @brief Sets i-th action description.
+ * @brief Sets a description of the specified action of the object.
*
- * @param action an AtkAction
- * @param i the action index corresponding to the action to be performed
+ * Implementation of set_description from AtkAction interface.
+ *
+ * @param action AtkAction instance
+ * @param i index of the action to be performed
* @param description action desciption
* @return TRUE if description was set successfully, FALSE otherwise
*/
}
/**
- * @brief Gets i-th action name.
+ * @brief Gets the name of the specified action of the object.
+ *
+ * Implementation of get_name from AtkAction interface.
*
- * @param action an AtkAction
- * @param i the action index corresponding to the action to be performed
- * @return action description string
+ * @param action AtkAction instance
+ * @param i index of the action to be performed
+ * @return string representing the name of the specified action
*/
static const char*
eail_hoversel_action_name_get(AtkAction *action,
}
/**
- * @brief Gets number of actions available on the object.
+ * @brief Gets the number of accessible actions available on the object.
+ *
+ * If there are more than one, the first one is considered the "default" action of the object.
+ *
+ * Implementation of get_n_actions from AtkAction interface.
*
* @param action AtkAction instance
- * @return number of implemented actions
+ * @return integer containing the number of implemented actions
*/
static int
eail_hoversel_n_actions_get(AtkAction *action)
}
/**
- * @brief Performs i-th action.
+ * @brief Performs the specified action on the object.
*
- * @param action an AtkAction instance
+ * Implementation of do_action from AtkAction interface.
+ *
+ * @param action AtkAction instance
* @param i action index
* @return TRUE on success, FALSE otherwise
*/
*/
/**
- * @brief Gets name of hoversel child
+ * @brief Gets the name of hoversel's child
*
- * @param parent instance
+ * @param parent parent instance
* @param item child instance
*
- * @returns const gchar * representing name of the child
+ * @returns string representing the name of the child
*/
static const gchar *
eail_hoversel_item_name_get(EailItemParent *parent, EailItem *item)
}
/**
- * @brief Implementation of EailItemParent->is_content_get_supported callback
+ * @brief Checks if content get is supported
+ *
+ * Implementation of EailItemParent->is_content_get_supported callback.
*
- * @param parent an EailItemParent
- * @param item an EailItem
+ * @param parent EailItemParent instance
+ * @param item EailItem instance
* @returns FALSE as there is no content support
*/
gboolean
/**
* @brief EailItemParent interface initializer
*
- * @param iface an EailItemParentIface
+ * @param iface EailItemParentIface instance
*/
static void
eail_item_parent_interface_init(EailItemParentIface *iface)
*/
/**
- * @brief Gets obj items list.
+ * @brief Gets obj's items list.
*
- * @param obj an EailHoversel
- * @return list with obj items
+ * @param obj EailHoversel instance
+ * @return Eina_List containing obj's items
*/
static const Eina_List *
eail_hoversel_items_get(EailHoversel *obj)
* @brief Macro upcasts an instance (obj) of a subclass to the EailHoversel
* type
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_HOVERSEL(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), \
EAIL_TYPE_HOVERSEL, EailHoversel))
/**
* @brief Tests whether object (obj) is an instance of EailHoversel class
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_IS_HOVERSEL(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), \
EAIL_TYPE_HOVERSEL))
/** @brief Definition of object structure for Atk EailHoversel*/
struct _EailHoversel
{
- EailWidget parent;/**< @brief widget that functionality is being extended*/
+ EailWidget parent;/**< @brief Parent widget whose functionality is being extended*/
char *shrink_description;/**< @brief 'shrink' action description string */
char *expand_description;/**< @brief 'expand' action description string */
/**
* @brief EailIcon initializer
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
* @param data initialization data
*/
static void
}
/**
- * @brief Gets obj name
+ * @brief Gets the name of obj
*
- * Returns obj name or obj icon file path if obj has no assigned name
- * or null if none of the previous applies
+ * Returns obj's name or obj's icon file path if obj has no assigned name,
+ * or null if none of the previous applies.
*
- * @param obj an AtkObject
- * @returns obj name or obj icon file path
+ * @param obj AtkObject instance
+ * @returns string representing obj's name or its file path,
+ * or null if obj doesn't have a name or an a file path
*/
static const gchar*
eail_icon_get_name(AtkObject *obj)
/**
* @brief EailIcon instance initializer
*
- * @param icon an EailIcon
+ * @param icon EailIcon instance
*/
static void
eail_icon_init(EailIcon *icon)
/**
* @brief EailItem class initializer
- * @param klass an EailIcon class
+ * @param klass EailIconClass instance
*/
static void
eail_icon_class_init(EailIconClass *klass)
* @brief Macro upcasts an instance (obj) of a subclass to the EailIcon
* type
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_ICON(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), \
EAIL_TYPE_ICON, EailIcon))
/**
* @brief Tests whether object (obj) is an instance of EailIcon class
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_IS_ICON(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), \
EAIL_TYPE_ICON))
/** @brief Definition of object structure for Atk EailIcon*/
struct _EailIcon
{
- /** @brief Parent object that functionality is being extended*/
+ /** @brief Parent widget whose functionality is being extended*/
EailImage parent;
};
#include "eail_image.h"
/**
- * @brief click action name
+ * @brief 'click' action name
*/
#define EAIL_IMAGE_ACTION_CLICK "click"
/**
* @brief Callback for "click" action on elm_image object
*
- * @param action EailImage instance
+ * @param action AtkAction instance
* @param data user data passed to callback
*
* @returns TRUE on success, FALSE otherwise
/**
*
- * @brief Initialize EailImage instance
+ * @brief Initializes AtkObject instance
*
- * @param obj EailImage instance
+ * @param obj AtkObject instance
* @param data user data passed to initialization
*/
static void
}
/**
- * @brief Finalize EailImage instance
+ * @brief Finalizes EailImage instance
*
- * @param object EailImage instance
+ * @param object GObject instance
*/
static void
eail_image_finalize(GObject *object)
}
/**
- * @brief Init EailImage instance
+ * @brief Initiates EailImage instance
*
* @param image EalImage instance
*/
}
/**
- * @brief Implementation on ref_state_set from AtkObject
+ * @brief Gets a reference to the state set of the accessible
*
- * @param obj EailImage instance
+ * The caller must unreference it when it is no longer needed.
*
- * @returns referred state set object
+ * Implementation of ref_state_set from AtkObject.
+ *
+ * @param obj AtkObject instance
+ *
+ * @returns AtkStateSet representing the state set of the accessible
*/
static AtkStateSet *
eail_image_ref_state_set(AtkObject *obj)
/**
* @brief EailImage class initialization
*
- * @param klass EailImageClass object
+ * @param klass EailImageClass instance
*/
static void
eail_image_class_init(EailImageClass *klass)
*/
/**
- * @brief Implementation of get_image_postition from AtkImage interface
+ * @brief Gets the position of the image in the form of a point specifying the images top-left corner
*
- * @param image EailImage instance
- * @param x address of int to store x coordinate
- * @param y address of int to store y coordinate
+ * Implementation of get_image_postition from AtkImage interface.
+ *
+ * @param image AtkImage instance
+ * @param [out] x x coordinate or -1 if value cannot be obtained
+ * @param [out] y y coordinate or -1 if value cannot be obtained
* @param coord_type specifies whether the coordinates are relative to the screen or to the components top level window
*/
static void
}
/**
- * @brief Implementation of get_image_size from AtkImage interface
+ * @brief Gets the width and height in pixels for the specified image
+ *
+ * The values of width and height are returned as -1 if the values
+ * cannot be obtained (for instance, if the object is not onscreen).
+ *
+ * Implementation of get_image_size from AtkImage interface.
*
* @param image EailImage instance
- * @param width address of int to store width
- * @param height address of int to store height
+ * @param [out] width width of image or -1 if value cannot be obtained
+ * @param [out] height height of image or -1 if value cannot be obtained
*/
static void
eail_image_size_get(AtkImage *image, gint *width, gint *height)
}
/**
- * @brief Implementation of get_image_description from AtkImage interface
+ * @brief Gets a textual description of the image
*
- * @param image EailImage instance
+ * Implementation of get_image_description from AtkImage interface.
+ *
+ * @param image AtkImage instance
*
- * @returns image description
+ * @returns string representing the image description
*/
static const gchar *
eail_image_description_get(AtkImage *image)
}
/**
- * @brief Implementation of set_image_description from AtkImage interface
+ * @brief Sets the textual description for the image
*
- * @param image EailImage instance
- * @param description image description to set
+ * Implementation of set_image_description from AtkImage interface.
+ *
+ * @param image AtkImage instance
+ * @param description image's description to set
*
* @returns TRUE on success
*/
}
/**
- * @brief Gets image locale (LC_MESSAGES variable)
+ * @brief Gets image's locale (LC_MESSAGES variable)
+ *
+ * @param image AtkImage instance
+ * @return string corresponding to the POSIX LC_MESSAGES
+ * locale used by the image description, or NULL if
+ * the image does not specify a locale
*
- * @param image an AtkImage
- * @return NULL if LC_MESSAGES not set, locale string otherwise
*/
const gchar *
eail_image_get_image_locale(AtkImage *image)
}
/**
- * @brief Initialize AtkImage interface
+ * @brief Initializes AtkImage interface
*
- * @param iface EailImage object
+ * @param iface AtkImageIface instance
*/
static void
atk_image_interface_init(AtkImageIface *iface)
* @brief Macro upcasts an instance (obj) of a subclass to the EailImage
* type
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_IMAGE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), \
EAIL_TYPE_IMAGE, EailImage))
/**
* @brief Tests whether object (obj) is an instance of EailImage class
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_IS_IMAGE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), \
EAIL_TYPE_IMAGE))
/** @brief Definition of object structure for Atk EailImage*/
struct _EailImage
{
- /** @brief Parent object that functionality is being extended*/
+ /** @brief Parent widget whose functionality is being extended*/
EailActionWidget parent;
- char *description; /*!< @brief image description*/
+ char *description; /*!< @brief Image description*/
};
/** @brief Definition of class structure for Atk EailImage*/
/**
* @file eail_index.c
- * @brief Implementation of Index widget
+ * @brief EailIndex implementation
*/
/* enabling beta API support for Eo parts*/
/**
* @brief Initializer for AtkObject
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
* @param data initialization data
*/
static void
/**
* @brief EailIndex GObject instance initializer
*
- * @param button an EailIndex
+ * @param button EailIndex instance
*/
static void
eail_index_init(EailIndex *button)
}
/**
- * @brief Gets list of Elm_Object_Item* that is contained in index widget
+ * @brief Gets the list of Elm_Object_Item* that are contained in an index widget
*
- * @param obj and EailIndex AtkObject
+ * @param obj AtkObject instance
*
- * @returns const Eina_List * with Elm_Object_Item* for every index
+ * @returns const Eina_List with Elm_Object_Item* for every index
*/
static const Eina_List *
eail_index_get_index_items(AtkObject *obj) {
return index_sd->items;
}
/**
- * @brief Implementation AtkObject->get_n_children callback
+ * @brief Gets the number of accessible children of the accessible.
*
- * ATK doc says:\n
- * Gets the number of accessible children of the accessible.
- * @param obj an AtkObject
+ * Implementation of AtkObject->get_n_children callback.
*
- * @returns an integer representing the number of accessible children of
+ * @param obj AtkObject instance
+ *
+ * @returns integer representing the number of accessible children of
* the accessible
*/
static gint
}
/**
- * @brief Implementation AtkObject->ref_child callback
+ * @brief Gets a reference to the specified accessible child of the object.
*
- * ATK doc says:\n
- * Gets a reference to the specified accessible child of the object. The
- * accessible children are 0-based so the first accessible child is at index 0,
+ * The accessible children are 0-based so the first accessible child is at index 0,
* the second at index 1 and so on.
*
- * @param obj an AtkObject
+ * Implementation of AtkObject->ref_child callback.
+ *
+ * @param obj AtkObject instance
* @param i index of a child
*
- * @returns an AtkObject representing the specified accessible child of the
- * accessible.
+ * @returns AtkObject representing the specified accessible child of the
+ * accessible
*/
static AtkObject *
eail_index_ref_child(AtkObject *obj, gint i)
}
/**
- * @brief Gets name of EailIndex
+ * @brief Gets the accessible name of the accessible.
*
- * Implementation of AtkObject->get_name callback
+ * Implementation of AtkObject->get_name callback.
*
- * ATK doc says:
- * Gets the accessible name of the accessible.
+ * @param obj AtkObject instance
*
- * @param obj an AtkObject
- *
- * @returns a character string representing the accessible description of
- * the accessible.
+ * @returns string containing the accessible description of
+ * the accessible
*/
static const gchar *
eail_index_get_name(AtkObject *obj)
}
/**
- * @brief Initializer for EailIndex GObject class (defines callbacks for
- * base AtkObject)
+ * @brief Initializer for EailIndex GObject class
*
- * @param klass an EailIndex class
+ * Defines callbacks for base AtkObject.
+ *
+ * @param klass EailIndex instance
*/
static void
eail_index_class_init(EailIndexClass *klass)
}
/**
- * @brief Implementation of EailItemParent->is_content_get_supported callback
+ * @brief Checks if content get is supported
+ *
+ * Implementation of EailItemParent->is_content_get_supported callback.
*
- * @param parent an EailItemParent
- * @param item an EailItem
- * @returns FALSE
+ * @param parent EailItemParent instance
+ * @param item EailItem instance
+ * @returns always FALSE
*/
gboolean
eail_index_content_get_support(EailItemParent *parent,
/**
* @brief Gets item's name
*
- * @param parent an EailItemParent
- * @param item an EailItem
- * @return item's name
+ * @param parent EailItemParent instance
+ * @param item EailItem instance
+ * @return string containing item's name
*/
const gchar *
eail_index_get_item_name(EailItemParent *parent,
/**
* @brief Initialization of EailItemParentIface callbacks
*
- * @param iface an EailItemParentIface
+ * @param iface EailItemParentIface instance
*/
static void
eail_item_parent_interface_init(EailItemParentIface *iface)
}
/**
- * @brief Implementation of AtkSelection->add_selection callback
+ * @brief Adds the specified accessible child of the object to the object's selection.
*
- * As described in ATK doc:\n
- * Adds the specified accessible child of the object to the object's selection.
+ * Implementation of AtkSelection->add_selection callback.
*
- * @param selection an AtkSelection
+ * @param selection AtkSelection instance
* @param i index of object
*
- * @returns TRUE if operation ended successfully, FALSE otherwise
+ * @returns TRUE if operation was successful, FALSE otherwise
*/
static gboolean
eail_index_add_selection(AtkSelection *selection,
}
/**
- * @brief Implementation of AtkSelection->ref_selection callback
+ * @brief Gets a reference to the accessible object representing the specified selected
+ * child of the object.
*
- * As described in ATK doc:\n
- * Gets a reference to the accessible object representing the specified selected
- * child of the object. Note: callers should not rely on NULL or on a zero value
+ * Note: callers should not rely on NULL or on a zero value
* for indication of whether AtkSelectionIface is implemented, they should use
* type checking/interface checking macros or the atk_get_accessible_value()
* convenience method.
*
- * @param selection an AtkSelection
+ * Implementation of AtkSelection->ref_selection callback.
+ *
+ * @param selection AtkSelection instance
* @param i index of object
*
- * @returns an AtkObject representing the selected accessible , or NULL if
+ * @returns AtkObject representing the selected accessible or NULL if
* selection does not implement this interface
*/
static AtkObject *
}
/**
- * @brief Implementation of AtkSelection->clear_selection callback
- *
- * As described in ATK doc:\n
- * Clears the selection in the object so that no children in the object are
+ * @brief Clears the selection in the object so that no children in the object are
* selected.
*
- * @param selection an AtkSelection
+ * Implementation of AtkSelection->clear_selection callback.
+ *
+ * @param selection aAtkSelection instance
*
* @returns TRUE if success, FALSE otherwise.
*/
}
/**
- * @brief Implementation of AtkSelection->get_selection_count callback
+ * @brief Gets the number of accessible children currently selected.
*
- * As described in ATK doc:\n
- * Gets the number of accessible children currently selected. Note: callers
- * should not rely on NULL or on a zero value for indication of whether
+ * Note: callers should not rely on NULL or on a zero value for indication of whether
* AtkSelectionIface is implemented, they should use type checking/interface
* checking macros or the atk_get_accessible_value() convenience method.
-
- * @param selection an AtkSelection
*
- * @returns gint representing number of selected elements
+ * Implementation of AtkSelection->get_selection_count callback.
+ *
+ * @param selection AtkSelection instance
+ *
+ * @returns integer representing the number of selected elements
*/
static gint
eail_index_get_selection_count(AtkSelection *selection)
}
/**
- * @brief Implementation of AtkSelection->is_child_selected callback
+ * @brief Determines if the current child of this object is selected.
*
- * As described in ATK doc:\n
- * Determines if the current child of this object is selected Note: callers
- * should not rely on NULL or on a zero value for indication of whether
+ * Note: callers should not rely on NULL or on a zero value for indication of whether
* AtkSelectionIface is implemented, they should use type checking/interface
* checking macros or the atk_get_accessible_value() convenience method.
*
- * @param selection an AtkSelection
+ * Implementation of AtkSelection->is_child_selected callback.
+ *
+ * @param selection AtkSelection instance
* @param i index of object
*
- * @returns a gboolean representing if the specified child is selected, or
- * FALSE if selection does not implement this interface.
+ * @returns TRUE if the specified child is selected or
+ * FALSE if selection does not implement this interface
*/
static gboolean
eail_index_is_child_selected(AtkSelection *selection,
/**
* @brief Initializer of AtkSelectionIface interface
*
- * @param iface an AtkSelectionIface
+ * @param iface AtkSelectionIface
*/
static void atk_selection_interface_init(AtkSelectionIface *iface)
{
* @brief Macro upcasts an instance (obj) of a subclass to the EailIndex
* type
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_INDEX(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), \
EAIL_TYPE_INDEX, EailIndex))
/**
* @brief Tests whether object (obj) is an instance of EailIndex class
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_IS_INDEX(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), \
EAIL_TYPE_INDEX))
/** @brief Definition of object structure for Atk EailIndex*/
struct _EailIndex
{
- /** @brief Parent object that functionality is being extended*/
+ /** @brief Parent widget whose functionality is being extended*/
EailWidget parent;
};
* @brief EailInwin object initialization
*
* @param obj EailInwin object
- * @param data user set additional initialization data
+ * @param data additional initialization data
*/
static void
eail_inwin_initialize(AtkObject *obj, gpointer data)
}
/**
- * @brief Implementation of get_widget_children from EailWidget
+ * @brief Gets EailWidget's children
+ *
+ * Implementation of get_widget_children from EailWidget.
*
* @param widget EailInwin instance
*
- * @return list of widgets, NULL if no children
+ * @return Eina_List representing a list of widget's children, or NULL if widget has no children
*/
static Eina_List *
eail_inwin_get_widget_children(EailWidget *widget)
* @brief Macro upcasts an instance (obj) of a subclass to the EailInwin
* type
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_INWIN(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), \
EAIL_TYPE_INWIN, EailInwin))
/**
* @brief Tests whether object (obj) is an instance of EailInwin class
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_IS_INWIN(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), \
EAIL_TYPE_INWIN))
/** @brief Definition of object structure for Atk EailInwin*/
struct _EailInwin
{
- /** @brief Parent object that functionality is being extended*/
+ /** @brief Parent widget whose functionality is being extended*/
EailWidget parent;
};
/**
* @file eail_item.c
- * @brief Implementation of widget that is being used to represent
- * list/toolbar/menu items/genlist items/genlist items...
+ * @brief EailItem implementation
*
* In general - this object represents all kinds of objects that have form of
* a Elm_Obj_Item* and need ATK accessible representation. It stores
/**
* @brief Initializer for AtkObjectClass
*
- * @param obj an AtkObject for EailItem
- * @param data additional initialization data (Elm_Object_Item *)
+ * @param obj AtkObject instance
+ * @param data additional initialization data
*/
static void
eail_item_initialize(AtkObject *obj, gpointer data)
*
* @param item EailItem to take nested Elm_Object_Item from
*
- * @returns nested Elm_Object_Item * object or NULL in case of error
+ * @returns Elm_Object_Item * representing nested item or NULL if an error occured
*/
Elm_Object_Item *
eail_item_get_item(EailItem *item)
*/
/**
- * @brief Gets name of EailItem
+ * @brief Gets the accessible name of the accessible.
*
- * Implementation of AtkObject->get_name callback
+ * Implementation of AtkObject->get_name callback.
*
- * ATK doc says:
- * Gets the accessible name of the accessible.
- *
- * @param obj an AtkObject for EailItem
- * @returns a character string representing the accessible description of
+ * @param obj AtkObject for EailItem
+ * @returns string representing the accessible description of
* the accessible.
*/
static const gchar *
}
/**
- * @brief Implementation of AtkObject->get_role callback
+ * @brief Gets the role of the accessible
+ *
+ * Implementation of AtkObject->get_role callback.
*
- * @param obj an AtkObject for EailItem
- * @returns ATK role of target item in the list
+ * @param obj AtkObject for EailItem
+ * @returns AtkRole representing the parameter's role
*/
static AtkRole
eail_item_get_role(AtkObject *obj)
}
/**
- * @brief Implementation of AtkObject->get_index_in_parent callback
+ * @brief Gets the 0-based index of this accessible in its parent.
*
- * ATK doc says:
- * Gets the 0-based index of this accessible in its parent; returns -1 if the
- * accessible does not have an accessible parent.
- * @param obj an AtkObject for EailItem
- * @returns an integer which is the index of the accessible in its parent
+ * Implementation of AtkObject->get_index_in_parent callback.
+ *
+ * @param obj AtkObject for EailItem
+ * @returns integer representing the index of the accessible in its parent or -1 if the accessible does not have an accessible parent
*/
static gint
eail_item_get_index_in_parent(AtkObject *obj)
}
/**
- * @brief Implementation of AtkObject->ref_state_set callback
+ * @brief Gets a reference to the state set of the accessible.
+ *
+ * The caller must unreference it when it is no longer needed.
*
- * ATK doc says:
- * Gets a reference to the state set of the accessible; the caller must
- * unreference it when it is no longer needed.
+ * Implementation of AtkObject->ref_state_set callback.
*
- * @param obj an AtkObject for EailItem
- * @returns a reference to an AtkStateSet which is the state set of the
- * accessible.
+ * @param obj AtkObject for EailItem
+ * @returns AtkStateSet containing a reference to the state set of the
+ * accessible
*/
static AtkStateSet *
eail_item_ref_state_set(AtkObject *obj)
/**
* @brief Initializer for GObject class
- * @param item an EailItem object
+ * @param item EailItem instance
*/
static void
eail_item_init(EailItem *item)
}
/**
- * @brief Finalize implementation for GObject class
- * @param obj an AtkObject for EailItem that needs to be finalized
+ * @brief Finalizes implementation for GObject class
+ * @param obj AtkObject for EailItem instance that needs to be finalized
*/
static void
eail_item_class_finalize(GObject *obj)
}
/**
- * @brief Helper function used for adding content Evas_Object* part if part
- * with given name is available
+ * @brief Helper function used for adding Evas_Object* content to the item's list
+ * if the content is available.
*
- * @param eail_obj_item item used for lookup for given content part
- * @param items list of items that will be extended by found part
- * @param part_str name of part to be found
+ * @param eail_obj_item item used for browsing for given content part
+ * @param items list of items that will be extended by the content part
+ * @param part_str name of content part to be found
*
- * @returns filled list with Evas_Object* objects
+ * @returns Eina_List filled with Evas_Object* objects
*/
static Eina_List *
_eail_item_append_part_if_exist(Elm_Object_Item *eail_obj_item,
}
/**
- * @brief Checks if content_get is supported by given EailItem object
+ * @brief Checks if content_get is supported by the given EailItem object
*
- * @param atk_object an AtkObject
+ * @param atk_object AtkObject instance
*
* @returns TRUE if content_get is supported, FALSE otherwise
*/
}
/**
- * @brief Gets list of item content parts with well documented content strings
+ * @brief Gets list of item's content parts with well documented content strings
*
* @param eail_item item to get content from
*
- * @returns list filled with Evas_Object* that has been found
+ * @returns Eina_List filled with the content parts that have been found
*/
static Eina_List *
_eail_item_get_basic_parts(EailItem *eail_item)
}
/**
- * @brief Helper function that adds unique entries from one list to another
+ * @brief Helper function for adding unique entries from one list to another
*
- * @param item_list source list, unique items will be appended here
- * @param additional_items list with potential items to add
+ * @param item_list list which unique items will be appended to
+ * @param additional_items source list with items to be added to item_list
*
- * @returns result list filled with unique entries from both lists
+ * @returns Eina_List filled with unique entries from both lists
*/
static Eina_List *
_eail_add_unique_listsparts(Eina_List *item_list,
}
/**
- * @brief Gets content part items from given EailItem object
+ * @brief Gets content part items from the given EailItem object
+ *
+ * List should be freed when results will be processed.
*
* @param eail_item EailItem object used to get content from
*
- * @returns content parts (Evas_Object *) for given item. List should be freed
- * when results will be processed.
+ * @returns Eina_List containing content parts for the given item.
*/
static Eina_List *
_eail_item_get_part_items(EailItem *eail_item)
}
/**
- * @brief Implementation AtkObject->get_n_children callback
+ * @brief Gets the number of accessible children of the accessible.
*
- * ATK doc says:\n
- * Gets the number of accessible children of the accessible.
+ * Implementation AtkObject->get_n_children callback.
*
- * @param obj an AtkObject (EailItem)
+ * @param obj AtkObject (EailItem) instance
*
- * @returns an integer representing the number of accessible children of
+ * @returns integer representing the number of accessible children of
* the accessible
*/
static gint
}
/**
- * @brief Implementation AtkObject->ref_child callback
+ * @brief Gets a reference to the specified accessible child of the object.
*
- * ATK doc says:\n
- * Gets a reference to the specified accessible child of the object. The
- * accessible children are 0-based so the first accessible child is at index 0,
+ * The accessible children are 0-based so the first accessible child is at index 0,
* the second at index 1 and so on.
*
- * @param obj an AtkObject for EailItem
- * @param i index of item to ref
+ * Implementation of AtkObject->ref_child callback.
+ *
+ * @param obj AtkObject for EailItem instance
+ * @param i index of item to reference
*
- * @returns an AtkObject representing the specified accessible child of the
- * accessible.
+ * @returns AtkObject representing the specified accessible child of the
+ * accessible
*/
static AtkObject *
eail_item_ref_child(AtkObject *obj, gint i)
}
/**
- * @brief Initializer for GObject class (defines callbacks for base AtkObject)
- * @param klass an EailItemClass
+ * @brief Initializer for GObject class
+ *
+ * Defines callbacks for base AtkObject.
+ *
+ * @param klass EailItemClass instance
*/
static void
eail_item_class_init(EailItemClass *klass)
*/
/**
- * @brief Implementation of AtkComponent->grab_focus callback
+ * @brief Grabs focus for this component.
*
- * ATK doc says:
- * Grabs focus for this component.
+ * Implementation of AtkComponent->grab_focus callback.
*
- * @param component an AtkComponent (EailItem)
- * @returns TRUE if successful, FALSE otherwise.
+ * @param component AtkComponent (EailItem) instance
+ * @returns TRUE on success, FALSE otherwise.
*/
static gboolean
eail_item_grab_focus(AtkComponent *component)
}
/**
- * @brief Implementation of AtkComponent->get_extents callback
+ * @brief Gets the rectangle which gives the extent of the component.
*
- * ATK doc says:
- * Gets the rectangle which gives the extent of the component.
+ * Implementation of AtkComponent->get_extents callback.
*
- * @param component an AtkComponent
- * @param x address of gint to put x coordinate
- * @param y address of gint to put y coordinate
- * @param width ddress of gint to put width
- * @param height address of gint to put height
+ * @param component AtkComponent instance
+ * @param [out] x rectangle upper left x coordinate
+ * @param [out] y rectangle upper left y coordinate
+ * @param [out] width width of the rectangle
+ * @param [out] height height of the rectangle
* @param coord_type specifies whether the coordinates are relative to the
* screen or to the components top level window
*/
}
/**
- * @brief AtkComponetn interface initialization
+ * @brief AtkComponent interface initialization
*
- * @param iface EailNaviframPage object
+ * @param iface EailNaviframPage instance
*/
static void
atk_component_interface_init(AtkComponentIface *iface)
/**
* @brief Gets actions supported by given EailItem object
*
- * @param action an AtkAction
+ * @param action AtkAction instance
*
* @returns EailActionSupported enum entry that shows what kind of actions are
* supported
}
/**
- * @brief Returns number of implemented ATK Actions.
- * Implementation of AtkActionIface get_n_actions callback
+ * @brief Returns the number of implemented ATK actions.
+ *
+ * Implementation of AtkActionIface get_n_actions callback.
*
* @param action object that implements AtkAction interface
- * @returns number of implemented actions
+ * @returns integer representing number of implemented actions
*/
static int
eail_item_n_actions_get(AtkAction *action)
}
/**
- * @brief Returns EailActionObj of action with given index
+ * @brief Returns the accessible name of the specified action
*
* @param action object that implements AtkAction interface
* @param i index (number) of action
- * @returns i-th action name
+ * @returns string containing the accessible name of the specified action
*/
static const char*
eail_item_action_name_get(AtkAction *action, int i)
}
/**
- * @brief Gets clickable Evas_Object for given EailItem
+ * @brief Gets the clickable Evas_Object for the given EailItem
*
- * @param atk_item an EailItem object
+ * @param atk_item EailItem instance
*
- * @returns Evas_Object * to click on or NULL of no clickable content was found
+ * @returns clickable Evas_Object or NULL of no clickable content was found
*/
static Evas_Object *
_eail_item_get_clickable_evas_obj(AtkObject *atk_item)
/**
- * @brief Performs action with name on given item
+ * @brief Performs an action with the given name on given item
*
- * @param atk_item item object to do action on
- * @param action_name name of action (eg. 'click', 'press'...)
+ * @param atk_item item object to perform the action on
+ * @param action_name name of the action (eg. 'click', 'press'...)
*
* @returns TRUE if operation was successful, FALSE otherwise
*/
/**
* \brief Launches action with given index
*
- * @param action object that implements AtkAction interface
- * @param i index (number) of action
+ * @param action AtkAction instance
+ * @param i index (number) of the action
*
* @returns TRUE if action was successfully launched, FALSE otherwise
*/
/**
* @brief Initializer for AtkActionIface
- * @param iface an AtkActionIface to fill
+ * @param iface AtkActionIface instance to fill
*/
static void
atk_action_interface_init(AtkActionIface *iface)
/**
* @brief Gets text content from item
*
- * Implementation of AtkTextIface->get_text callback\n
+ * Implementation of AtkTextIface->get_text callback.
+ *
+ * Use g_free() to free the returned.
*
- * @param text an AtkText
+ * @param text AtkText instance
* @param start_offset start position
* @param end_offset end position, or -1 for the end of the string.
*
* @returns a newly allocated string containing the text from start_offset
- * up to, but not including end_offset. Use g_free() to free the returned
+ * up to, but not including end_offset.
* string.
*/
static gchar*
}
/**
- * @brief Gets character from item at given offset
+ * @brief Gets character from an item at the given offset
*
- * Implementation of AtkTextIface->get_character_at_offset callback
+ * Implementation of AtkTextIface->get_character_at_offset callback.
*
- * @param text an AtkText
- * @param offset an offset
+ * @param text AtkText instance
+ * @param offset offset to get the character from
*
- * @returns the character at offset.
+ * @returns char located at offset
*/
static gunichar
eail_item_get_character_at_offset(AtkText *text, gint offset)
}
/**
- * @brief Gets character count from text content in item
- * Implementation of AtkTextIface->get_character_count callback
+ * @brief Gets the character count from text content in item
+ *
+ * Implementation of AtkTextIface->get_character_count callback.
*
- * @param text an AtkText
+ * @param text AtkText instance
*
- * @returns the character count
+ * @returns integer representing the character count
*/
static gint
eail_item_get_character_count(AtkText *text)
/**
* @brief Initializer for AtkTextinterface
- * @param iface an AtkTextIface to fill
+ * @param iface AtkTextIface instance to fill
*/
static void
atk_text_interface_init(AtkTextIface *iface)
* @brief Macro upcasts an instance (obj) of a subclass to the EailItem
* type
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_ITEM(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), \
EAIL_TYPE_ITEM, EailItem))
/**
* @brief Tests whether object (obj) is an instance of EailItem class
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_IS_ITEM(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), \
EAIL_TYPE_ITEM))
/** @brief Definition of object structure for Atk EailItem*/
struct _EailItem
{
- /** @brief Parent object that functionality is being extended*/
+ /** @brief Parent AtkObject whose functionality is being extended*/
AtkObject parent;
/** @brief Elementary item that is being represented by EailItem accessible
#include "eail_item_parent.h"
/**
+ * @brief Gets GType for initialized interface
*
* @returns GType for initialized interface
*/
}
/**
+ * @brief Gets the name of item
+ *
* @param parent object that holds EailItem in its content
- * @param item an EailItem object
+ * @param item EailItem instance
*
- * @return gchar* representing name of item or NULL if not available
+ * @return string representing the name of item or NULL if the name is not available
*/
const gchar *
eail_item_parent_get_item_name(EailItemParent *parent,
}
/**
+ * @brief Gets the role of item
+ *
* @param parent object that holds EailItem in its content
- * @param item an EailItem object
+ * @param item EailItem object
*
- * @returns ATK role for given EailItem
+ * @returns AtkRole representing the role of the specified EailItem
*/
AtkRole
eail_item_parent_get_item_role(EailItemParent *parent,
}
/**
+ * @brief Gets the index of item in parent object
+ *
* @param parent object that holds EailItem in its content
- * @param item an EailItem object
+ * @param item EailItem instance
*
- * @returns gint representing index of item in parent object
+ * @returns integer representing the index of item in parent object
*/
gint
eail_item_parent_get_item_index_in_parent(EailItemParent *parent,
}
/**
+ * @brief Gets the number of accessible children
+ *
* @param parent object that holds EailItem in its content
- * @param item an EailItem object
+ * @param item EailItem instance
*
- * @returns gint representing index of item in parent object or -1 if
+ * @returns integer representing the number of accessible children or -1 if
* not implemented
*/
gint
}
/**
+ * @brief Gets a reference to the specified accessible child of the object.
+ *
+ * The accessible children are 0-based so the first accessible child
+ * is at index 0, the second at index 1 and so on.
+ *
* @param parent object that holds EailItem in its content
- * @param item an EailItem object
+ * @param item EailItem instance
* @param index gint representing index of child to ref
*
- * @returns AtkObject * for given index or NULL if not implemented
+ * @returns AtkObject representing the specified accessible child
+ * or NULL if not implemented
*/
AtkObject *
eail_item_parent_ref_n_child(EailItemParent *parent,
}
/**
+ * @brief Gets a reference to the state set of EailItem
+ *
* @param parent object that holds EailItem in its content
- * @param item an EailItem object
- * @param state_set current state_set
+ * @param item EailItem instance
+ * @param state_set current state set
*
- * @returns AtkStateSet representing state set of given EailItem
+ * @returns AtkStateSet representing the state set of given EailItem
*/
AtkStateSet *
eail_item_parent_ref_item_state_set(EailItemParent *parent,
}
/**
+ * @brief Grabs focus of EailItem
+ *
* @param parent object that holds EailItem in its content
- * @param item an EailItem object
+ * @param item EailItem instance
*
- * @returns TRUE if operation was successfull, FALSE otherwise
+ * @returns TRUE on success, FALSE otherwise
*/
gboolean
eail_item_parent_grab_item_focus(EailItemParent *parent,
}
/**
- * ATK doc says:
- * Gets the rectangle which gives the extent of the component.
+ * @brief Gets the rectangle which gives the extent of the component
+ *
+ * Implementation of atk_component_get_extents.
*
* @param parent object that holds EailItem in its content
- * @param item an EailItem object
- * @param x address of gint to put x coordinate
- * @param y address of gint to put y coordinate
- * @param width addrress of gint to put width
- * @param height address of gint to put height
+ * @param item EailItem object
+ * @param [out] x x coordinate
+ * @param [out] y y coordinate
+ * @param [out] width width of the rectangle
+ * @param [out] height height of the rectangle
* @param coord_type specifies whether the coordinates are relative to the
* screen or to the components top level window
*/
}
/**
+ * @brief Gets nested Evas_Object of given EailItem
+ *
* @param parent object that holds EailItem in its content
- * @param item an EailItem object
+ * @param item EailItem instance
*
- * @returns nested Evas_Object for given EailItem
+ * @returns nested Evas_Object representing the given EailItem
*/
Evas_Object * eail_item_parent_get_evas_obj(EailItemParent *parent,
EailItem *item)
}
/**
+ * @brief Gets supported actions
+ *
* @param parent object that holds EailItem in its content
- * @param item an EailItem object
+ * @param item EailItem instance
*
- * @returns filled gint representing supported actions
+ * @returns integer representing supported actions
*/
gint
eail_item_parent_get_actions_supported(EailItemParent *parent,
}
/**
+ * @brief Checks if content get is supported
+ *
* @param parent object that holds EailItem in its content
- * @param item an EailItem object
+ * @param item EailItem instance
*
* @returns TRUE if content get is supported, FALSE otherwise. Default
* implementation returns TRUE (used if no redefinition in EailItemParent
* @brief Macro upcasts an instance (obj) of a subclass to the EailItemParent
* interface
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_ITEM_PARENT(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), \
EAIL_TYPE_ITEM_PARENT, EailItemParent))
/**
* @brief Tests whether object (obj) implements EailItemParent interface
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_IS_ITEM_PARENT(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), \
EAIL_TYPE_ITEM_PARENT))
/** @brief Definition of interface structure for Atk EailItemParent*/
struct _EailItemParentIface
{
- GTypeInterface parent;/**< @brief parent interface that is being extended*/
+ GTypeInterface parent;/**< @brief Parent interface that is being extended*/
- /**@brief callback definition for eail_item_parent_get_item_name func*/
+ /**@brief Callback definition for eail_item_parent_get_item_name function*/
const gchar *(*get_item_name) (EailItemParent *parent,
EailItem *item);
- /**@brief callback definition for eail_item_parent_get_item_role func*/
+ /**@brief Callback definition for eail_item_parent_get_item_role function*/
AtkRole (*get_item_role) (EailItemParent *parent,
EailItem *item);
- /**@brief callback definition for eail_item_parent_get_index_in_parent func*/
+ /**@brief Callback definition for eail_item_parent_get_index_in_parent function*/
gint (*get_item_index_in_parent) (EailItemParent *parent,
EailItem *item);
- /**@brief callback definition for eail_item_parent_get_n_children func*/
+ /**@brief Callback definition for eail_item_parent_get_n_children function*/
gint (*get_n_children) (EailItemParent *parent,
EailItem *item);
- /**@brief callback definition for eail_item_parent_ref_n_child func*/
+ /**@brief Callback definition for eail_item_parent_ref_n_child function*/
AtkObject * (*ref_n_child) (EailItemParent *parent,
EailItem *item,
gint index);
- /**@brief callback definition for eail_item_parent_ref_item_state_set func*/
+ /**@brief Callback definition for eail_item_parent_ref_item_state_set function*/
AtkStateSet *
(*ref_item_state_set) (EailItemParent *parent,
EailItem *item,
AtkStateSet *state_set);
/* AtkComponent interface */
- /**@brief callback definition for eail_item_parent_grab_item_focus func*/
+ /**@brief Callback definition for eail_item_parent_grab_item_focus function*/
gboolean (*grab_item_focus) (EailItemParent *parent,
EailItem *item);
- /**@brief callback definition for eail_item_parent_get_item_extents func*/
+ /**@brief Callback definition for eail_item_parent_get_item_extents function*/
void (*get_item_extents) (EailItemParent *parent,
EailItem *item,
gint *x,
gint *height,
AtkCoordType coord_type);
- /**@brief callback definition for eail_item_parent_get_evas_obj func*/
+ /**@brief Callback definition for eail_item_parent_get_evas_obj function*/
Evas_Object * (*get_evas_obj) (EailItemParent *parent,
EailItem *item);
- /**@brief callback definition for eail_item_parent_get_actions_supported
- * func*/
+ /**@brief Callback definition for eail_item_parent_get_actions_supported
+ * function*/
gboolean (*get_actions_supported) (EailItemParent *parent,
EailItem *item);
- /**@brief callback definition for eail_item_parent_is_content_get_supported
- * func*/
+ /**@brief Callback definition for eail_item_parent_is_content_get_supported
+ * function*/
gboolean (*is_content_get_supported) (EailItemParent *parent,
EailItem *item);
};
-/** @brief Enum that is used to represent supported actions by item*/
+/** @brief Enum that is used for representing supported actions by item*/
enum EailActionSupported
{
EAIL_ACTION_SUPPORTED_NONE = 1 << 0,
}
/**
- * @brief Gets state set of the accessible.
+ * @brief Gets the state set of the accessible.
*
* The caller must unreference it when it is no longer needed.
*
* @param accessible AtkObject instance
- * @return accessible state set
+ * @return AtkStateSet containing the state set of the accessible
*/
static AtkStateSet*
eail_label_ref_state_set(AtkObject *accessible)
}
/**
- * @brief Gets obj name
+ * @brief Gets obj's name
*
- * Returns obj accessible name if assigned, obj text content otherwise
- *
- * @param obj an AtkObject
- * @returns accessible obj name if assigned, obj text content otherwise
+ * @param obj AtkObject instance
+ * @returns string containing obj's name or its text content if the name is not set
*/
static const gchar*
eail_label_get_name(AtkObject *obj)
/**
* @brief EailLabel class initializer.
*
- * @param klass EailLabel class
+ * @param klass EailLabelClass instance
*/
static void
eail_label_class_init(EailLabelClass *klass)
}
/**
- * @brief Gets character at offset
+ * @brief Gets the character at offset
*
- * @param text an AtkText
+ * @param text AtkText instance
* @param offset character offset
- * @return character at offset
+ * @return char located at the given offset
*/
static gunichar
eail_label_get_character_at_offset(AtkText *text,
}
/**
- * @brief Gets text length
+ * @brief Gets the length of text
*
- * @param text an AtkText
- * @return text length
+ * @param text AtkText instance
+ * @return integer representing the length of text
*/
static gint
eail_label_get_character_count(AtkText *text)
/**
* @brief Adds attribute to attribute set
*
- * @param attrib_set The AtkAttributeSet to add the attribute to
- * @param attr The AtkTextAttrribute which identifies the attribute to be added
- * @param value The attribute value
+ * @param attrib_set AtkAttributeSet to add the attribute to
+ * @param attr AtkTextAttrribute to be added
+ * @param value attribute value
*
* Creates an AtkAttribute from attr and value, and adds it
* to attrib_set.
*
- * @returns: A pointer to the new AtkAttributeSet.
+ * @returns AtkAttributeSet containing set with added attribute
**/
AtkAttributeSet*
_eail_label_add_attribute(AtkAttributeSet *attrib_set,
* @brief Creates an AtkAttributeSet which consists of the default values of
* attributes for the text.
*
- * @param text an AtkText
- *
- * @returns an AtkAttributeSet which contains the default values of attributes
- * at offset. this atkattributeset should be freed by a call to
+ * This AtkAttributeSet should be freed by a call to
* atk_attribute_set_free()
+ *
+ * @param text AtkText instance
+ *
+ * @returns AtkAttributeSet containing default values of attributes
+ * at offset.
*/
AtkAttributeSet *
eail_label_get_default_attributes(AtkText *text)
/**
* @brief Creates an AtkAttributeSet which consists of the attributes
- * explicitly set at the position offset in the text. start_offset and
- * end_offset are set to the start and end of the range around offset
- * where the attributes are invariant. Note that end_offset is the offset
- * of the first character after the range.
+ * explicitly set at the position offset in the text.
*
- * @param text an AtkText
+ * start_offset and end_offset are set to the start and end of the range around offset
+ * where the attributes are invariant.
+ *
+ * Note that end_offset is the offset of the first character after the range.
+ *
+ * This AtkAttributeSet should be freed by a call to
+ * atk_attribute_set_free()
+ *
+ * @param text AtkText instance
* @param offset the offset at which to get the attributes
- * @param start_offset the address to put the start offset of the range (used to
- * store output value)
- * @param end_offset the address to put the end offset of the range (used to
- * store output value)
+ * @param [out] start_offset start offset of the range
+ * @param [out] end_offset end offset of the range
*
* @returns an AtkAttributeSet which contains the attributes explicitly set at
- * offset. This AtkAttributeSet should be freed by a call to
- * atk_attribute_set_free()
+ * offset.
*/
AtkAttributeSet *
eail_label_get_run_attributes(AtkText *text,
/**
* @brief Initializes AtkTextIface interface
*
- * @param iface an AtkTextIface
+ * @param iface AtkTextIface instance
*/
static void
atk_text_interface_init(AtkTextIface *iface)
* @brief Macro upcasts an instance (obj) of a subclass to the EailLabel
* type
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_LABEL(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), \
EAIL_TYPE_LABEL, EailLabel))
/**
* @brief Tests whether object (obj) is an instance of EailLabel class
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_IS_LABEL(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), \
EAIL_TYPE_LABEL))
/** @brief Definition of object structure for Atk EailLabel*/
struct _EailLabel
{
- /** @brief Parent object that functionality is being extended*/
+ /** @brief Parent widget whose functionality is being extended*/
EailWidget parent;
};
/**
* @file eail_layout.c
*
- * @brief Implementation of Layout widget
+ * @brief EailLayout implementation
*/
#include <Elementary.h>
eail_dynamic_content_interface_init));
/**
- * @brief Gets elementary widgets from layout edje object
- * Iterates over edje smart objects and if object is elementary widget
- * then it is append to the list
+ * @brief Gets elementary widgets from a layout edje object
*
- * @param edje layout edje object
+ * Iterates over edje smart objects and if an object is an elementary widget
+ * then it is appended to the list.
*
- * @returns list of Elementary widgets
+ * @param edje layout edje instance
+ *
+ * @returns Eina_List representing the list of Elementary widgets
*/
static Eina_List *
_get_widgets_from_edje(const Evas_Object *edje)
}
/**
- * @brief Implementations of get_widget_children from EailWidget
+ * @brief Gets accessible children of object
+ *
+ * Implementation of get_widget_children from EailWidget.
*
- * @param object EailLayout instance
+ * @param object EailWidget instance
*
- * @returns list of Evas_Objects
+ * @returns Eina_List representing the list of object's children
*/
static Eina_List*
eail_layout_widget_children_get(EailWidget *object)
}
/**
- * @brief Initialize EailLayout object
+ * @brief Initializes EailLayout object
*
- * @param object EailLayout instance
+ * @param object AtkObject instance
* @param data user data passed to initialization
*/
static void
}
/**
- * @brief Init EailLayout instance
+ * @brief Initiates EailLayout instance
*
* @param layout EailLayout instance
*/
}
/**
- * @brief Init EailLayout class
+ * @brief Initiates EailLayout class
*
- * @param klass EailLayoutClass object
+ * @param klass EailLayoutClass instance
*/
static void
eail_layout_class_init(EailLayoutClass *klass)
* @brief Macro upcasts an instance (obj) of a subclass to the EailLayout
* type
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_LAYOUT(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), \
EAIL_TYPE_LAYOUT, EailLayout))
/**
* @brief Tests whether object (obj) is an instance of EailLayout class
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_IS_LAYOUT(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), \
EAIL_TYPE_LAYOUT))
/** @brief Definition of object structure for Atk EailLayout*/
struct _EailLayout
{
- /** @brief Parent object that functionality is being extended*/
+ /** @brief Parent widget whose functionality is being extended*/
EailWidget parent;
gint child_count_last;/**< @brief last reported count of children */
};
/**
* @file eail_list.c
- * @brief Implementation of list widget
+ * @brief EailList implementation
*/
#include <Elementary.h>
/**
* @brief Initializer for AtkObjectClass
*
- * @param obj an AtkObject
- * @param data Initialization data
+ * @param obj AtkObject instance
+ * @param data initialization data
*/
static void
eail_list_initialize(AtkObject *obj, gpointer data)
* @brief Prepares Eina_List filled with Elm_Object_Item* objects
* representing items in the list
*
- * @param list an EailList
+ * Call eina_list_free on the returned when results processing has been finished.
*
- * @return filled list with list items. Call eina_list_free on that list when
- * results processing has been finished
+ * @param list EailList instance
+ *
+ * @return Eina_List representing a list of the list's item
*/
static Eina_List *
eail_list_get_items(EailList *list)
}
/**
- * @brief Implementation AtkObject->get_n_children callback
+ * @brief Gets the number of accessible children of the accessible
*
- * ATK doc says:\n
- * Gets the number of accessible children of the accessible.
+ * Implementation of AtkObject->get_n_children callback.
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*
- * @returns an integer representing the number of accessible children of
+ * @returns integer representing the number of accessible children of
* the accessible
*/
static gint
}
/**
- * @brief Implementation AtkObject->ref_child callback
+ * @brief Gets a reference to the specified accessible child of the object.
*
- * ATK doc says:\n
- * Gets a reference to the specified accessible child of the object. The
- * accessible children are 0-based so the first accessible child is at index 0,
+ * The accessible children are 0-based so the first accessible child is at index 0,
* the second at index 1 and so on.
*
- * @param obj an AtkObject
+ * Implementation of AtkObject->ref_child callback.
+ *
+ * @param obj AtkObject instance
* @param i child index
*
- * @returns an AtkObject representing the specified accessible child of the
- * accessible.
+ * @returns AtkObject representing the specified accessible child of the
+ * accessible
*/
static AtkObject *
eail_list_ref_child(AtkObject *obj, gint i)
}
/**
- * @brief Implementation AtkObject->ref_state_set callback
+ * @brief Gets a reference to the state set of the accessible
*
- * ATK doc says:\n
- * Gets a reference to the state set of the accessible; the caller must
- * unreference it when it is no longer needed.
+ * The caller must unreference it when it is no longer needed.
*
- * @param obj an AtkObject
+ * Implementation of AtkObject->ref_state_set callback.
*
- * @returns reference to an AtkStateSet which is the state set of the
+ * @param obj AtkObject instance
+ *
+ * @returns AtkStateSet representing the state set of the
* accessible
*/
static AtkStateSet *
/**
* @brief Initializer for GObject EailList instance
*
- * @param list an EailList
+ * @param list EailList instance
*/
static void
eail_list_init(EailList *list)
}
/**
- * @brief Initializer for GObject class (defines callbacks for base AtkObject)
+ * @brief Initializer for GObject class
+ *
+ * Defines callbacks for base AtkObject.
*
- * @param klass an EailList class
+ * @param klass EailListClass instance
*/
static void
eail_list_class_init(EailListClass *klass)
*/
/**
- * @brief Implementation of EailItemParent->get_item_role callback
+ * @brief Gets the role of item
*
- * @param parent an EailItemParent
- * @param item an EailItem
+ * Implementation of EailItemParent->get_item_role callback.
*
- * @returns role of target item in the list
+ * @param parent EailItemParent instance
+ * @param item EailItem instance
+ *
+ * @returns AtkRole representing the role of the specified item in the list
*/
static AtkRole
eail_list_get_item_role(EailItemParent *parent,
}
/**
- * @brief Implementation of EailItemParent->ref_item_state_set callback
+ * @brief Gets a reference to the state set of item
+ *
+ * Implementation of EailItemParent->ref_item_state_set callback.
*
- * @param parent an EailItemParent
- * @param item an EailItem
- * @param state_set an AtkStateSet
- * @returns items state set
+ * @param parent EailItemParent instance
+ * @param item EailItem instance
+ * @param state_set AtkStateSet instance
+ * @returns AtkStateSet representing the state set of item
*/
static AtkStateSet *
eail_list_ref_item_state_set(EailItemParent *parent,
}
/**
- * @brief Implementation of EailItemParent->ref_item_state_set callback
+ * @brief Grabs focus of list
*
- * @param parent an EailItemParent
- * @param item an EailItem
+ * @param parent EailItemParent instance
+ * @param item EailItem instance
* @returns TRUE on success, FALSE otherwise
*/
static gboolean
}
/**
- * @brief Implementation of EailItemParent->get_evas_obj callback
+ * @brief Gets nested Evas_Object of given EailItem
+ *
+ * Implementation of EailItemParent->get_evas_obj callback.
*
- * @param parent an EailItemParent
- * @param item an EailItem
- * @returns item object
+ * @param parent EailItemParent instance
+ * @param item EailItem instance
+ * @returns Evas_Object representing item
*/
static Evas_Object *
eail_list_get_evas_obj(EailItemParent *parent,
}
/**
- * @brief Implementation of EailItemParent->get_actions_supported callback
+ * @brief Gets supported actions
*
- * @param parent an EailItemParent
- * @param item an EailItem
- * @returns enum representing supported actions
+ * Implementation of EailItemParent->get_actions_supported callback.
+ *
+ * @param parent EailItemParent instance
+ * @param item EailItem instance
+ * @returns integer representing supported actions
*/
static gint
eail_list_get_actions_supported(EailItemParent *parent,
}
/**
- * @brief Get name of list child
+ * @brief Gets the name of a list's child
*
- * @param parent EailList instance
- * @param item EailList child instance
+ * @param parent EailItemParent instance
+ * @param item EailItem child instance
*
- * @returns const gchar * representing name of the child
+ * @returns string representing the name of the child
*/
static const gchar *
eail_list_item_name_get(EailItemParent *parent, EailItem *item)
/**
* @brief Initialization of EailItemParentIface callbacks
*
- * @param iface an EailItemParent interface
+ * @param iface EailItemParent instance
*/
static void
eail_item_parent_interface_init(EailItemParentIface *iface)
*/
/**
- * @brief Implementation of AtkSelection->add_selection callback
+ * @brief Adds the specified accessible child of the object to the object's selection
*
- * As described in ATK doc:\n
- * Adds the specified accessible child of the object to the object's selection.
+ * Implementation of AtkSelection->add_selection callback.
*
- * @param selection an AtkSelection
+ * @param selection AtkSelection instance
* @param i index of object
*
- * @returns TRUE if operation ended successfully, FALSE otherwise
+ * @returns TRUE on success, FALSE otherwise
*/
static gboolean
eail_list_add_selection(AtkSelection *selection,
}
/**
- * @brief Implementation of AtkSelection->ref_selection callback
+ * @brief Gets a reference to the accessible object representing the specified selected
+ * child of the object.
*
- * As described in ATK doc:\n
- * Gets a reference to the accessible object representing the specified selected
- * child of the object. Note: callers should not rely on NULL or on a zero value
+ * Note: callers should not rely on NULL or on a zero value
* for indication of whether AtkSelectionIface is implemented, they should use
* type checking/interface checking macros or the atk_get_accessible_value()
* convenience method.
*
- * @param selection an AtkSelection
+ * Implementation of AtkSelection->ref_selection callback.
+ *
+ * @param selection AtkSelection instance
* @param i index of object
*
- * @returns an AtkObject representing the selected accessible , or NULL if
- * selection does not implement this interface
+ * @returns AtkObject representing the selected accessible
*/
static AtkObject *
eail_list_ref_selection(AtkSelection *selection,
}
/**
- * @brief Implementation of AtkSelection->get_selection_count callback
+ * @brief Gets the number of accessible children currently selected.
*
- * As described in ATK doc:\n
- * Gets the number of accessible children currently selected. Note: callers
- * should not rely on NULL or on a zero value for indication of whether
+ * Note: callers should not rely on NULL or on a zero value for indication of whether
* AtkSelectionIface is implemented, they should use type checking/interface
* checking macros or the atk_get_accessible_value() convenience method.
-
- * @param selection an AtkSelection
*
- * @returns gint representing number of selected elements
+ * Implementation of AtkSelection->get_selection_count callback.
+ *
+ * @param selection AtkSelection instance
+ *
+ * @returns integer representing the number of selected elements
*/
static gint
eail_list_get_selection_count(AtkSelection *selection)
}
/**
- * @brief Implementation of AtkSelection->is_child_selected callback
+ * @brief Determines if the current child of this object is selected.
*
- * As described in ATK doc:\n
- * Determines if the current child of this object is selected Note: callers
- * should not rely on NULL or on a zero value for indication of whether
+ * Note: callers should not rely on NULL or on a zero value for indication of whether
* AtkSelectionIface is implemented, they should use type checking/interface
* checking macros or the atk_get_accessible_value() convenience method.
*
- * @param selection an AtkSelection
+ * Implementation of AtkSelection->is_child_selected callback.
+ *
+ * @param selection AtkSelection instance
* @param i index of object
*
- * @returns a gboolean representing if the specified child is selected, or
- * FALSE if selection does not implement this interface.
+ * @returns gboolean representing whether the specified child is selected
*/
static gboolean
eail_list_is_child_selected(AtkSelection *selection,
}
/**
- * @brief Implementation of AtkSelection->remove_selection callback
+ * @brief Removes the specified child of the object from the object's selection
*
- * As described in ATK doc:\n
- * Removes the specified child of the object from the object's selection.
+ * Implementation of AtkSelection->remove_selection callback.
*
- * @param selection an AtkSelection
- * @param i slection index
+ * @param selection AtkSelection instance
+ * @param i selection index
*
- * @returns TRUE if success, FALSE otherwise.
+ * @returns TRUE on success, FALSE otherwise
*/
static gboolean
eail_list_remove_selection(AtkSelection *selection,
* @brief Helper function that selects/unselects all items in the list depending
* on "selected" param value
*
- * @param object an Evas_Object
+ * @param object Evas_Object instance
* @param selected selected state (TRUE means selected)
*
- * @returns TRUE if success, FALSE otherwise.
+ * @returns TRUE on success, FALSE otherwise
*/
static gboolean
eail_list_mark_all_selected_state(const Evas_Object *object, Eina_Bool selected)
}
/**
- * @brief Implementation of AtkSelection->select_all_selection callback
+ * @brief Causes every child of the object to be selected if the object supports
+ * multiple selections
*
- * As described in ATK doc:\n
- * Causes every child of the object to be selected if the object supports
- * multiple selections.
+ * Implementation of AtkSelection->select_all_selection callback.
*
- * @param selection an AtkSelection
+ * @param selection AtkSelection instance
*
- * @returns TRUE if success, FALSE otherwise.
+ * @returns TRUE on success, FALSE otherwise
*/
static gboolean
eail_list_select_all_selection(AtkSelection *selection)
}
/**
- * @brief Implementation of AtkSelection->clear_selection callback
+ * @brief Clears the selection in the object so that no child in the object is
+ * selected
*
- * As described in ATK doc:\n
- * Clears the selection in the object so that no children in the object are
- * selected.
+ * Implementation of AtkSelection->clear_selection callback.
*
- * @param selection an AtkSelection
+ * @param selection AtkSelection instance
*
- * @returns TRUE if success, FALSE otherwise.
+ * @returns TRUE on success, FALSE otherwise
*/
static gboolean
eail_list_clear_selection(AtkSelection *selection)
/**
* @brief Initializer of AtkSelectionIface interface
*
- * @param iface an AtkSelection interface
+ * @param iface AtkSelectionIface instance
*/
static void atk_selection_interface_init(AtkSelectionIface *iface)
{
* @brief Macro upcasts an instance (obj) of a subclass to the EailList
* type
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_LIST(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), \
EAIL_TYPE_LIST, EailList))
/**
* @brief Tests whether object (obj) is an instance of EailList class
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_IS_LIST(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), \
EAIL_TYPE_LIST))
/** @brief Definition of object structure for Atk EailList*/
struct _EailList
{
- /** @brief Parent object that functionality is being extended*/
+ /** @brief Parent widget whose functionality is being extended*/
EailScrollableWidget parent;
};
#include "eail_utils.h"
/**
- * @brief Press action name
+ * @brief 'press' action name
*/
#define EAIL_MAP_ACTION_PRESS "press"
/**
- * @brief ScrollUp action name
+ * @brief 'scroll up' action name
*/
#define EAIL_MAP_ACTION_SCROLL_UP "scroll_up"
/**
- * @brief ScrollDown action name
+ * @brief 'scroll down' action name
*/
#define EAIL_MAP_ACTION_SCROLL_DOWN "scroll_down"
/**
- * @brief ScrollLeft action name
+ * @brief 'scroll left' action name
*/
#define EAIL_MAP_ACTION_SCROLL_LEFT "scroll_left"
/**
- * @brief ScrollRight action name
+ * @brief 'scroll right' action name
*/
#define EAIL_MAP_ACTION_SCROLL_RIGHT "scroll_right"
/**
- * @brief ZoomIn action name
+ * @brief 'zoom in' action name
*/
#define EAIL_MAP_ACTION_ZOOM_IN "zoom_in"
/**
- * @brief ZoomOut action name
+ * @brief 'zoom out' action name
*/
#define EAIL_MAP_ACTION_ZOOM_OUT "zoom_out"
/**
* @brief EailMap initializer
*
- * @param object an AtkObject
+ * @param object AtkObject instance
* @param data initialization data
*/
static void
/**
* @brief EailMap finalizer
*
- * @param object a GObject
+ * @param object GObject instance
*/
static void
eail_map_finalize(GObject *object)
}
/**
- * @brief Gets object name
+ * @brief Gets obj's name
*
- * @param object an AtkObject
- * @return EailMap name if name is assigned, map path otherwise
+ * @param object AtkObject instance
+ * @return string containing obj's name if a name is assigned, map path otherwise
*/
static const gchar*
eail_map_name_get(AtkObject *object)
/**
* @brief EailMap instance initializer
*
- * @param map an EailMap
+ * @param map EailMap instance
*/
static void
eail_map_init(EailMap *map)
/**
* @brief EailMap class initializer
*
- * @param klass an EailMapClass
+ * @param klass EailMapClass instance
*/
static void
eail_map_class_init(EailMapClass *klass)
*
* Image size is the same as window size
*
- * @param image an AtkImage
- * @param [out] width image width
- * @param [out] height image height
+ * @param image AtkImage instance
+ * @param [out] width image width or -1 if the value cannot be obtained
+ * @param [out] height image height or -1 if the value cannot be obtained
*/
static void
eail_map_image_size_get(AtkImage *image, gint *width, gint *height)
/**
* @brief AtkImage interface initializer
*
- * @param iface an AtkImage interface
+ * @param iface AtkImageIface instance
*/
static void
akt_image_interface_init(AtkImageIface *iface)
*/
/**
- * @brief ScrollUp action callback
+ * @brief 'scroll up' action callback
*
- * @param action an AtkAction
+ * @param action AtkAction instance
* @param data callback data
* @return TRUE on success, FALSE otherwise
*/
}
/**
- * @brief ScrollDown action callback
+ * @brief 'scroll down' action callback
*
* @param action an AtkAction
* @param data callback data
}
/**
- * @brief ScrollLeft action callback
+ * @brief 'scroll left' action callback
*
- * @param action an AtkAction
+ * @param action AtkAction instance
* @param data callback data
* @return TRUE on success, FALSE otherwise
*/
}
/**
- * @brief ScrollRight action callback
+ * @brief 'scroll right' action callback
*
* @param action an AtkAction
* @param data callback data
}
/**
- * @brief ZoomIn action callback
+ * @brief 'zoom in' action callback
*
- * @param action an AtkAction
+ * @param action AtkAction instance
* @param data data passed to callback
* @return TRUE on success, FALSE otherwise
*/
}
/**
- * @brief ZoomOut action callback
+ * @brief 'zoom out' action callback
*
- * @param action an AtkAction
+ * @param action AtkAction instance
* @param data data passed to callback
* @return TRUE on success, FALSE otherwise
*/
}
/**
- * @brief Press action callback
+ * @brief 'press' action callback
*
- * @param action an AtkAction
+ * @param action AtkAction instance
* @param data data passed to callback
* @return TRUE on success, FALSE otherwise
*/
/**
* @brief Sets EailMap actions
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
static void
eail_map_set_actions(AtkObject *obj)
* @brief Macro upcasts an instance (obj) of a subclass to the EailMap
* type
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_MAP(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), \
EAIL_TYPE_MAP, EailMap))
/**
* @brief Tests whether object (obj) is an instance of EailMap class
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_IS_MAP(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), \
EAIL_TYPE_MAP))
/** @brief Definition of object structure for Atk EailMap*/
struct _EailMap
{
- EailImage parent;/**< @brief widget that functionality is being extended*/
- const char *name;/**< @brief name string property for map*/
+ EailImage parent;/**< @brief Parent widget whose functionality is being extended*/
+ const char *name;/**< @brief Name string property for map*/
};
/** @brief Definition of object class for Atk EailMap*/
/**
* @brief EailMapbuf initializer
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
* @param data initialization data
*/
static void
obj->role = ATK_ROLE_IMAGE_MAP;
}
/**
- * @brief Gets widget children
+ * @brief Gets widget's children
*
- * @param widget an EailWidget
- * @return widget children list
+ * @param widget EailWidget instance
+ * @return Eina_List containing widget's children
*/
static Eina_List*
eail_mapbuf_children_get(EailWidget *widget)
}
/**
- * @brief Gets object state set
+ * @brief Gets object's state set
*
- * The caller must unreference it when it is no longed needed
+ * The caller must unreference it when it is no longed needed.
*
- * @param object an AtkObject
- * @return object state set
+ * @param object AtkObject instance
+ * @return AtkStateSet* containing object's state set
*/
static AtkStateSet*
eail_mapbuf_ref_state_set(AtkObject *object)
/**
* @brief EailMapbuf instance initializer
*
- * @param mapbuf an EailMapbuf
+ * @param mapbuf EailMapbuf instance
*/
static void
eail_mapbuf_init(EailMapbuf *mapbuf)
/**
* @brief EailMapbuf class initializer
*
- * @param klass an EailMapbuf class
+ * @param klass EailMapbufClass instance
*/
static void
eail_mapbuf_class_init(EailMapbufClass *klass)
* @brief Macro upcasts an instance (obj) of a subclass to the EailMapbuf
* type
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_MAPBUF(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), \
EAIL_TYPE_MAPBUF, EailMapbuf))
/**
* @brief Tests whether object (obj) is an instance of EailMapbuf class
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_IS_MAPBUF(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), \
EAIL_TYPE_MAPBUF))
/** @brief Definition of object structure for Atk EailMapbuf*/
struct _EailMapbuf
{
- /** @brief Parent object that functionality is being extended*/
+ /** @brief Parent widget whose functionality is being extended*/
EailWidget parent;
};
/**
* @file eail_menu.c
- * @brief Implementation of menu widget
+ * @brief EailMenu implementation
*/
#include <Elementary.h>
* @brief Prepares Eina_List filled with Elm_Object_Item* objects
* representing items in menu
*
- * @param list an EailMenu
+ * Call eina_list_free on the returned list when results processing has been finished.
*
- * @return filled list with list items. Call eina_list_free on that list when
- * results processing has been finished
+ * @param list EailMenu instance
+ *
+ * @return Eina_List representing the list of list's items
*/
static Eina_List *
eail_menu_get_items(EailMenu *list)
}
/**
- * @brief Implementation of AtkObject->get_n_children callback
+ * @brief Gets the number of accessible children of the accessible
*
- * ATK doc says:\n
- * Gets the number of accessible children of the accessible.
+ * Implementation of AtkObject->get_n_children callback.
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*
- * @returns an integer representing the number of accessible children of
+ * @returns integer representing the number of accessible children of
* the accessible
*/
static gint
}
/**
- * @brief Implementation of AtkObject->ref_child callback
+ * @brief Gets a reference to the specified accessible child of the object.
*
- * ATK doc says:\n
- * Gets a reference to the specified accessible child of the object. The
- * accessible children are 0-based so the first accessible child is at index 0,
+ * The accessible children are 0-based so the first accessible child is at index 0,
* the second at index 1 and so on.
*
- * @param obj an AtkObject
+ * Implementation of AtkObject->ref_child callback.
+ *
+ * @param obj AtkObject instance
* @param i child index
*
- * @returns an AtkObject representing the specified accessible child of the
- * accessible.
+ * @returns AtkObject representing the specified accessible child of the
+ * accessible
*/
static AtkObject *
eail_menu_ref_child(AtkObject *obj, gint i)
/**
- * @brief Gets name of EailItem
+ * @brief Gets the accessible name of the accessible
*
- * Implementation of AtkObject->get_name callback
+ * Implementation of AtkObject->get_name callback.
*
- * ATK doc says:
- * Gets the accessible name of the accessible.
+ * @param obj AtkObject instance
*
- * @param obj an AtkObject
- *
- * @returns a character string representing the accessible description of
- * the accessible.
+ * @returns character string representing the accessible name of
+ * the accessible
*/
static const gchar *
eail_menu_get_name(AtkObject *obj)
/**
* @brief Initializer for GObject EailMenu instance
- * @param menu an EailMenu
+ *
+ * @param menu EailMenu instance
*/
static void
eail_menu_init(EailMenu *menu)
}
/**
- * @brief Initializer for GObject class (defines callbacks for base AtkObject)
- * @param klass an EailMenuClass
+ * @brief Initializer for GObject class
+ *
+ * Defines callbacks for base AtkObject.
+ *
+ * @param klass EailMenuClass instance
*/
static void
eail_menu_class_init(EailMenuClass *klass)
/* Child MenuItem handling - implementation of EailItemParent interface*/
/**
- * @brief Get name of list child
+ * @brief Gets the name of a list's child
*
- * @param parent EailList instance
- * @param item EailList child instance
+ * @param parent EailItemParent instance
+ * @param item EailItem child instance
*
- * @returns const gchar * representing name of the child
+ * @returns string representing the name of the child
*/
static const gchar *
eail_menu_item_name_get(EailItemParent *parent, EailItem *item)
}
/**
- * @brief Implementation of EailItemParent->get_evas_obj callback
+ * @brief Gets nested Evas_Object of given EailItem
*
- * @param parent an EailItemParent
- * @param item an EailItem
- * @returns menu item
+ * Implementation of EailItemParent->get_evas_obj callback.
+ *
+ * @param parent EailItemParent instance
+ * @param item EailItem instance
+ * @returns Evas_Object representing the menu item
*/
Evas_Object *
eail_menu_item_get_evas_obj(EailItemParent *parent,
}
/**
- * @brief Implementation of EailItemParent->get_actions_supported callback
+ * @brief Gets supported actions
+ *
+ * Implementation of EailItemParent->get_actions_supported callback.
*
- * @param parent an EailItemParent
- * @param item an EailItem
- * @returns enum representing supported actions
+ * @param parent EailItemParent instance
+ * @param item EailItem instance
+ * @returns integer representing supported actions
*/
static gint
eail_menu_get_actions_supported(EailItemParent *parent,
/**
* @brief Prepares Eina_List filled with Elm_Object_Item* objects
* representing items in the list
+ *
+ * Call eina_list_free on the returned list when results processing has been finished.
+ *
* @param menu_item_obj child of menu widget
*
- * @return filled list with menu items. Call eina_list_free on that list when
- * results processing has been finished
+ * @return Eina_List representing the list of menu items
*/
static const Eina_List *
eail_menu_item_get_items(EailItem *menu_item_obj)
}
/**
- * @brief Implementation of AtkObject->get_n_children callback
+ * @brief Gets the number of accessible children of the accessible
*
- * ATK doc says:\n
- * Gets the number of accessible children of the accessible.
+ * Implementation of AtkObject->get_n_children callback.
*
* @param parent EAIL representation of menu widget
* @param eail_item child of menu widget
*
- * @returns an integer representing the number of accessible children of
+ * @returns integer representing the number of accessible children of
* the accessible
*/
static gint
/**
* @brief Creates content widgets from given menu_item AtkObject
*
- * @param menu_item_obj an AtkObject menu item
- * @returns AtkObject representing nested content in menu item
+ * @param menu_item_obj AtkObject menu item
+ * @returns AtkObject representing the nested content of menu item
*/
static AtkObject *
_eail_menu_item_create_content_atk_obj(AtkObject *menu_item_obj)
}
/**
- * @brief Implementation of AtkObject->ref_child callback
+ * @brief Gets a reference to the specified accessible child of the object.
*
- * ATK doc says:\n
- * Gets a reference to the specified accessible child of the object. The
- * accessible children are 0-based so the first accessible child is at index 0,
+ * The accessible children are 0-based so the first accessible child is at index 0,
* the second at index 1 and so on.
*
- * @param parent an EailItemParent
- * @param item an EailItem
+ * Implementation of AtkObject->ref_child callback.
+ *
+ * @param parent EailItemParent instance
+ * @param item EailItem instance
* @param i child index
*
- * @returns an AtkObject representing the specified accessible child of the
- * accessible.
+ * @returns AtkObject representing the specified accessible child of the
+ * accessible
*/
static AtkObject *
eail_menu_item_ref_child(EailItemParent *parent,
}
/**
- * @brief Implementation of EailItemParent->is_content_get_supported callback
+ * @brief Checks if content get is supported
+ *
+ * Implementation of EailItemParent->is_content_get_supported callback.
*
- * @param parent an EailItemParent
- * @param item an EailItem
- * @returns FALSE
+ * @param parent EailItemParent instance
+ * @param item EailItem instance
+ * @returns always FALSE
*/
gboolean
eail_menu_item_content_get_support(EailItemParent *parent,
/**
* @brief Initializes EailItemParentIface callbacks
*
- * @param iface an EailItemParent interface
+ * @param iface EailItemParentIface instance
*/
static void
eail_item_parent_interface_init(EailItemParentIface *iface)
* @brief Macro upcasts an instance (obj) of a subclass to the EailMenu
* type
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_MENU(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), \
EAIL_TYPE_MENU, EailMenu))
/**
* @brief Tests whether object (obj) is an instance of EailMenu class
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_IS_MENU(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), \
EAIL_TYPE_MENU))
/** @brief Definition of object structure for Atk EailMenu*/
struct _EailMenu
{
- /** @brief Parent object that functionality is being extended*/
+ /** @brief Parent widget whose functionality is being extended*/
EailWidget parent;
};
eail_item_parent_interface_init));
/**
- * @brief Implementation of EailItemParent->is_content_get_supported callback
+ * @brief Checks if content get is supported
*
- * @param parent an EailItemParent
- * @param item an EailItem
- * @returns FALSE
+ * Implementation of EailItemParent->is_content_get_supported callback.
+ *
+ * @param parent EailItemParent instance
+ * @param item EailItem instance
+ * @returns always FALSE
*/
gboolean
eail_multibuttonentry_content_get_support(EailItemParent *parent,
}
/**
- * @brief Get name of Multibuttonentry child
+ * @brief Gets the name of a multibuttonentry's child
*
- * Implementation of get_item_name callback of EailItemParent interface
+ * Implementation of get_item_name callback of EailItemParent interface.
*
- * @param parent Multibuttonentry instance
- * @param item Multibuttonentry child instance
+ * @param parent EailItemParent instance representing a multibuttonentry
+ * @param item Multibuttonentry EailItem instance representing a child
*
- * @returns const gchar * representing name of the child
+ * @returns string representing the name of the child
*/
static const gchar *
eail_multibuttonentry_item_name_get(EailItemParent *parent, EailItem *item)
*
* Initialization of callbacks used by EailItemParent interface.
*
- * @param iface an EailItemParentIface
+ * @param iface EailItemParentIface instance
*/
static void
eail_item_parent_interface_init(EailItemParentIface *iface)
/**
* @brief Gets text bounded by start_offset and end_offset
*
- * Use g_free() to free the returned string
+ * Use g_free() to free the returned string.
*
- * @param text an AtkText
+ * @param text AtkText instance
* @param start_offset start position
- * @param end_offset end position, -1 for the end of the string
+ * @param end_offset end position or -1 for the end of the string
* @return string containing text from start_offset up to, but not including
* end_offset
*/
}
/**
- * @brief Gets character at offset
+ * @brief Gets the character at offset
*
- * @param text an AtkText
- * @param offset
- * @return character at offset
+ * @param text AtkText instance
+ * @param offset offset to obtain the character from
+ * @return char representing the character at given offset
*/
static gunichar
eail_multibuttonentry_get_character_at_offset(AtkText *text,
}
/**
- * @brief Gets text length
+ * @brief Gets the length of text
*
- * @param text an AtkText
- * @return text length
+ * @param text AtkText instance
+ * @return integer representing text's length
*/
static gint
eail_multibuttonentry_get_character_count(AtkText *text)
/**
* @brief AktText initialization function
*
- * @param iface an AtkTextIface
+ * @param iface AtkTextIface instance
*/
static void
atk_text_interface_init(AtkTextIface *iface)
/**
* @brief Sets text contents of text
*
- * @param text an AtkEditableText
+ * @param text AtkEditableText instance
* @param string new text to be set
*/
static void
/**
* @brief Copies text content from entry to clipboard
*
- * @param text an AtkEditableText
- * @param start_pos start position of cursor
- * @param end_pos end position of cursor
+ * @param text AtkEditableText instance
+ * @param start_pos index of copied text's first character
+ * @param end_pos index of last copied text's last character
*/
static void
eail_multibuttonentry_copy_text(AtkEditableText *text,
/**
* @brief Cuts text content from entry to clipboard
*
- * @param text an AtkEditableText
- * @param start_pos start position of cursor
- * @param end_pos end position of cursor
+ * @param text AtkEditableText instance
+ * @param start_pos index of cut text's first character
+ * @param end_pos index of cut text's last character
*/
static void
eail_multibuttonentry_cut_text(AtkEditableText *text,
/**
* @brief Pastes text content from clipboard into entry
*
- * @param text an AtkEditableText
- * @param position start position of cursor
+ * @param text AtkEditableText instance
+ * @param position index of pasted text's first character
*/
static void
eail_multibuttonentry_paste_text(AtkEditableText *text,
* @brief Deletes text between start_pos and end_pos but not
* including end_pos
*
- * @param text an AtkEditableText
+ * @param text AtkEditableText instance
* @param start_pos start position
* @param end_pos end position
*/
}
/**
- * @brief Inserts text at given position
+ * @brief Inserts text at the given position
+ *
+ * After the call it points at the position after the newly inserted text.
*
- * @param text an AtkEditableText
+ * @param text AtkEditableText instance
* @param string string to insert
* @param length string length
- * @param [out] position at witch text is inserted.
- * After the call it points at the position after the newly inserted text.
+ * @param [out] position position to insert the text
+ *
*/
static void
eail_multibuttonentry_insert_text(AtkEditableText *text,
/**
* @brief Initialization for AtkEditableTextIface interface
*
- * Function called upon instance creation. It initializes AtkText interface
+ * Function called upon instance creation.
+ *
+ * It initializes AtkText interface
* implementation i.e hooks method pointers in the interface structure
* to the implementing class's implementation.
*
- * @param iface an AtkEditableTextIface
+ * @param iface AtkEditableTextIface instance
*/
static void
atk_editable_text_interface_init(AtkEditableTextIface *iface)
}
/**
- * @brief Expand action callback
+ * @brief 'expand' action callback
*
- * @param action an AtkAction
+ * @param action AtkAction instance
* @param data user data passed to callback
*
* @returns TRUE on action success, FALSE otherwise
}
/**
- * @brief Shrink action callback
+ * @brief 'shrink' action callback
*
- * @param action an AtkAction
+ * @param action AtkAction instance
* @param data user data passed to callback
*
* @returns TRUE on action success, FALSE otherwise
}
/**
- * @brief Registers multibuttonentry actions
+ * @brief Registers multibuttonentry's actions
*
- * @param action_widget an EailActionWidget
+ * @param action_widget EailActionWidget instance
*/
static void eail_multibuttonentry_actions_init(EailActionWidget *action_widget)
{
/**
* @brief EailMultibuttonentry type initializer
- * @param obj an AtkObject
+ * @param obj AtkObject instance
* @param data initialization data
*/
void
/**
* @brief EailMultibuttonentry instance initializer
*
- * @param multibuttonentry an EailMultibuttonentry
+ * @param multibuttonentry EailMultibuttonentry instance
*/
static void
eail_multibuttonentry_init(EailMultibuttonentry *multibuttonentry)
}
/**
- * @brief Gets obj state set
+ * @brief Gets obj's state set
*
- * The caller must unreference it when it is no longer needed
+ * The caller must unreference it when it is no longer needed.
*
- * @param obj an AtkObject
- * @return obj state set
+ * @param obj AtkObject instance
+ * @return AtkStateSet containing object's state set
*/
static AtkStateSet *
eail_multibuttonentry_ref_state_set(AtkObject *obj)
}
/**
- * @brief Gets multibuttonentry items list
+ * @brief Gets the list of multibuttonentry's items
*
- * @param multibuttonentry an EailMultibuttonentry
- * @return multibuttonentry items list
+ * @param multibuttonentry EailMultibuttonentry instance
+ * @return Eina_List containing multibuttonentry's items
* */
static const Eina_List *
eail_multibuttonentry_get_items(EailMultibuttonentry *multibuttonentry)
}
/**
- * @brief Gets obj children number
+ * @brief Gets the number of accessible children of the accessible
*
- * @param obj an AtkObject
- * @return children number
+ * @param obj AtkObject instance
+ * @return integer representing the number of accessible children of the accessible
*/
static gint
eail_multibuttonentry_get_n_children(AtkObject *obj)
}
/**
- * @brief Gets reference to i-th obj child
+ * @brief Gets a reference to the specified child of obj
*
- * The caller must unreference it when it is no longer needed
+ * The caller must unreference it when it is no longer needed.
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
* @param i child index
- * @return child reference
+ * @return AtkObject containing reference to the specified child of obj
*/
static AtkObject *
eail_multibuttonentry_ref_child(AtkObject *obj, gint i)
/**
* @brief EailMultibuttonentry class initializer
*
- * @param klass an EailMultibuttonentry class
+ * @param klass EailMultibuttonentryClass instance
*/
static void
eail_multibuttonentry_class_init(EailMultibuttonentryClass *klass)
* @brief Macro upcasts an instance (obj) of a subclass to the EailMultibuttonentry
* type
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_MULTIBUTTONENTRY(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), \
EAIL_TYPE_MULTIBUTTONENTRY, EailMultibuttonentry))
/**
* @brief Tests whether object (obj) is an instance of EailMultibuttonentry class
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_IS_MULTIBUTTONENTRY(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), \
EAIL_TYPE_MULTIBUTTONENTRY))
/** @brief Definition of object structure for Atk EailMultibuttonentry*/
struct _EailMultibuttonentry
{
- /** @brief widget that functionality is being extended*/
+ /** @brief Parent widget whose functionality is being extended*/
EailActionWidget parent;
};
/**
* @file eail_naviframe.c
- * @brief Implementation of Naviframe widget
+ * @brief EailNaviframe implementation
*/
#include "eail_naviframe.h"
G_DEFINE_TYPE(EailNaviframe, eail_naviframe, EAIL_TYPE_ACTION_WIDGET);
/**
- * @brief Implementation AtkObject->get_n_children callback
+ * @brief Gets the number of accessible children of the accessible
*
- * ATK doc says:\n
- * Gets the number of accessible children of the accessible.
+ * Implementation of AtkObject->get_n_children callback.
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*
- * @returns an integer representing the number of accessible children of
+ * @returns integer representing the number of accessible children of
* the accessible
*/
static gint
}
/**
- * @brief click action callback
+ * @brief 'click' action callback
*
- * @param action an AtkAction
+ * @param action AtkAction instance
* @param data user data
* @return TRUE on success, FALSE otherwise
*/
}
/**
- * @brief Inits Action interface for Naviframe
+ * @brief Initializes Action interface for Naviframe
*
- * @param action_widget an EailActionWidget
+ * @param action_widget EailActionWidget instance
*/
static void eail_naviframe_actions_init(EailActionWidget *action_widget)
{
/**
* @brief Initializer for GObject EailNaviframe instance
*
- * @param naviframe an EailNaviframe
+ * @param naviframe EailNaviframe instance
*/
static void
eail_naviframe_init(EailNaviframe *naviframe)
/**
* @brief Returns naviframe-page implementation for given object item
*
- * @param naviframe an naviframe AtkObject
- * @param item an Elm_Object_Item for naviframe-page
+ * @param naviframe AtkObject instance
+ * @param item Elm_Object_Item for naviframe-page
*
- * @returns an AtkObject* representation for naviframe-page
+ * @returns AtkObject representation of naviframe-page
*/
static AtkObject *
_eail_naviframe_get_naviframe_page_for_item(AtkObject *naviframe,
}
/**
- * @brief Implementation AtkObject->ref_child callback
+ * @brief Gets a reference to the specified accessible child of the object.
*
- * ATK doc says:\n
- * Gets a reference to the specified accessible child of the object. The
- * accessible children are 0-based so the first accessible child is at index 0,
+ * The accessible children are 0-based so the first accessible child is at index 0,
* the second at index 1 and so on.
*
- * @param obj an AtkObject
+ * Implementation of AtkObject->ref_child callback.
+ *
+ * @param obj AtkObject instance
* @param i child index
*
- * @returns an AtkObject representing the specified accessible child of the
- * accessible.
+ * @returns AtkObject representing the specified accessible child of the
+ * accessible
*/
static AtkObject *
eail_naviframe_ref_child(AtkObject *obj, gint i)
}
/**
- * @brief Destructor for naviframe object
+ * @brief Destructor of naviframe object
+ * @param obj GObject instance
*/
static void
eail_naviframe_finalize(GObject *obj)
}
/**
- * @brief handler for event which is raised when naviframe page is changed
+ * @brief Handler for event which is raised when naviframe page is changed
* ("transition,finished" event)
*
- * @param data passed to callback
- * @param obj object that raised event
+ * @param data data passed to callback
+ * @param obj Evas_Object that raised event
* @param event_info additional event info
*/
void
/**
* @brief Initializer for AtkObjectClass
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
* @param data initialization data
*/
static void
}
/**
- * @brief Initializer for GObject naviframe class (defines callbacks for base
- * AtkObject)
+ * @brief Initializer for GObject naviframe class
+ *
+ * Defines callbacks for base AtkObject.
*
- * @param klass an EailNaviframeClass
+ * @param klass EailNaviframeClass instance
*/
static void
eail_naviframe_class_init(EailNaviframeClass *klass)
* @brief Macro upcasts an instance (obj) of a subclass to the EailNaviframe
* type
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_NAVIFRAME(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), \
EAIL_TYPE_NAVIFRAME, EailNaviframe))
/**
* @brief Tests whether object (obj) is an instance of EailNaviframe class
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_IS_NAVIFRAME(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), \
EAIL_TYPE_NAVIFRAME))
/** @brief Definition of object structure for Atk EailNaviframe*/
struct _EailNaviframe
{
- EailActionWidget parent;/**< @brief widget that functionality is being extended*/
- char *click_description;/**< @brief string description for 'click' action*/
- int child_count_last;/**< @brief last reported cound of children */
+ EailActionWidget parent;/**< @brief Parent widget whose functionality is being extended*/
+ char *click_description;/**< @brief String description for 'click' action*/
+ int child_count_last;/**< @brief Last reported count of children */
};
/** @brief Definition of object class for Atk EailNaviframe*/
/**
* @file eail_naviframe_page.c
- * @brief naviframe content page as AtkObject implementation
+ * @brief EailNaviframePage implementation
*/
#include "eail_naviframe_page.h"
static void atk_component_interface_init(AtkComponentIface *iface);
/**
- * Defines EailNaviframPage type
+ * Defines EailNaviframePage type
*/
G_DEFINE_TYPE_WITH_CODE(EailNaviframePage,
eail_naviframe_page,
atk_component_interface_init));
/**
- * @brief
+ * @brief Creates a new instance of an accessible naviframe page
*
- * @param naviframe an AtkObject
- * @param navi_tab_item an Elm_Object_Item item
- * @returns accessible naviframe page
+ * @param naviframe AtkObject instance
+ * @param navi_tab_item Elm_Object_Item instance
+ * @returns AtkObject representing the accessible naviframe page
*/
AtkObject *
eail_naviframe_page_new(AtkObject *naviframe, Elm_Object_Item *navi_tab_item)
}
/**
- * @brief Implementation atk_object_get_name
- * Returns accessible name if assigned, title or subtitle otherwise
+ * @brief Returns the accessible name if assigned, title or subtitle otherwise
*
- * @param obj EailNaviframePage instance
- * @returns obj accessible name if assigned, title or subtitle otherwise
+ * Implementation of atk_object_get_name from AtkObject.
+ *
+ * @param obj AtkObject instance
+ * @returns string representing the accessible name if assigned, title or subtitle otherwise
*/
static const char *
eail_naviframe_page_name_get(AtkObject *obj)
}
/**
- * @brief Init EailNaviframePage
+ * @brief Initiates EailNaviframePage
*
- * @param naviframe_page object instance
+ * @param naviframe_page EailNaviframePage instance
*/
static void
eail_naviframe_page_init(EailNaviframePage *naviframe_page)
}
/**
- * @brief Initialize EailNaviframPage
+ * @brief Initializes EailNaviframPage
*
- * @param obj object instance
+ * @param obj AtkObject instance
* @param data user data
*/
static void
}
/**
- * @brief Finalize object
+ * @brief Finalizes object
*
- * @param obj object instance
+ * @param obj AtkObject instance
*/
static void
eail_naviframe_page_finalize(GObject *obj)
}
/**
- * @brief Gets object children number
+ * @brief Gets the number of accessible children of obj
*
- * @param obj object instance
+ * @param obj AtkObject instance
*
- * @returns number of children
+ * @returns integer representing the number of children
*/
static gint
eail_naviframe_page_n_children_get(AtkObject *obj)
}
/**
- * @brief Get object parent
+ * @brief Gets obj's parent
*
- * @param obj object instance
+ * @param obj AtkObject instance
*
- * @returns object parent
+ * @returns AtkObject representing the parent of obj
*/
static AtkObject *
eail_naviframe_page_parent_get(AtkObject *obj)
}
/**
- * @brief Get referred child object
+ * @brief Gets a reference to the specified child of obj
*
- * @param obj object instance
+ * @param obj AtkObject instance
* @param i child index
*
- * @returns referred child object
+ * @returns AtkObject representing the specified child
*/
static AtkObject *
eail_naviframe_page_ref_child(AtkObject *obj, gint i)
}
/**
- * @brief Get index of object in parent object
+ * @brief Gets the index of obj in parent object
*
- * @param obj object instance
+ * @param obj AtkObject instance
*
- * @returns object index
+ * @returns integer representing the index of object
*/
static gint
eail_naviframe_page_index_in_parent_get(AtkObject *obj)
}
/**
- * @brief Get state set of accessible object
+ * @brief Gets the state set of the accessible object
*
- * @param obj object instance
+ * @param obj AtkObject instance
*
- * @returns referred AtkStateSet object
+ * @returns AtkStateSet representing the state set of the accessible object
*/
static AtkStateSet *
eail_naviframe_page_ref_state_set(AtkObject *obj)
/**
* @brief EailNaviframePage class initializer
*
- * @param klass EailNaviframePage class
+ * @param klass EailNaviframePageClass instance
*/
static void
eail_naviframe_page_class_init(EailNaviframePageClass *klass)
}
/**
- * @brief Implementation of get_extents from AtkComponetnt interface
+ * @brief Gets the rectangle which gives the extent of the component
+ *
+ * Implementation of get_extents from AtkComponent interface.
*
- * @param component object instance
- * @param x address of gint to store x coordinate
- * @param y address of gint to store y coordinate
- * @param width address of gint to store width
- * @param height address of gint to store height
- * @param coord_type coordinates type as ATK defines
+ * @param component AtkComponent instance
+ * @param [out] x x coordinate
+ * @param [out] y y coordinate
+ * @param [out] width width of the rectangle
+ * @param [out] height height of the rectangle
+ * @param coord_type specifies whether the coordinates are relative to the screen or to the component's top level window
*/
static void
eail_naviframe_page_get_extents(AtkComponent *component,
}
/**
- * @brief AtkComponetn interface initialization
+ * @brief AtkComponent interface initialization
*
- * @param iface EailNaviframPage object
+ * @param iface AtkComponentIface instance
*/
static void atk_component_interface_init(AtkComponentIface *iface)
{
* @brief Macro upcasts an instance (obj) of a subclass to the EailNaviframePage
* type
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_NAVIFRAME_PAGE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj),\
EAIL_TYPE_NAVIFRAME_PAGE, EailNaviframePage))
/**
* @brief Tests whether object (obj) is an instance of EailNaviframePage class
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_IS_NAVIFRAME_PAGE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj),\
EAIL_TYPE_NAVIFRAME_PAGE))
/** @brief Definition of object structure for Atk EailNaviframePage*/
struct _EailNaviframePage
{
- AtkObject parent; /*!< EailNaviframePage parent*/
-
- AtkObject *parent_naviframe; /*!< EailNaviframe to which page belongs to*/
- Evas_Object *naviframe; /*!< elm_naviframe instance*/
- Elm_Object_Item *page; /*!< elm_naviframe item instance*/
-
- Evas_Object *content[4]; /*!< holds content of page*/
-
- gint child_count; /*!< number of children*/
- const char *name; /*!< title of page*/
+ /** @brief Parent AtkObject whose functionality is being extended*/
+ AtkObject parent;
+ /** @brief EailNaviframe which page belongs to*/
+ AtkObject *parent_naviframe;
+ /** @brief elm_naviframe instance*/
+ Evas_Object *naviframe;
+ /** @brief elm_naviframe_item instance*/
+ Elm_Object_Item *page;
+ /** @brief Holds the content of a page*/
+ Evas_Object *content[4];
+ /** @brief Number of children*/
+ gint child_count;
+ /** @brief Title of the page*/
+ const char *name;
};
/** @brief Definition of object class for Atk EailNaviframePage*/
/**
* @file eail_notify.c
- * @brief Implementation of notify widget
+ * @brief EailNotify implementation
*/
#include <atk/atk.h>
/**
* @brief Initializer for AtkObject
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
* @param data initialization data
*/
static void
/**
* @brief Initializer for GObject EailNotify instance
*
- * @param button an EailNotify
+ * @param button EailNotify instance
*/
static void
eail_notify_init(EailNotify *button)
}
/**
- * @brief Helper function for getting nested content in notify widget
+ * @brief Helper function for getting nested content in a notify widget
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*
- * @returns nested widget content from notify widget
+ * @returns Evas_Object representing nested content in the notify widget
*/
static Evas_Object *
_eail_get_nested_widget(AtkObject *obj)
}
/**
- * @brief Implementation AtkObject->get_n_children callback
+ * @brief Gets the number of accessible children of the accessible.
*
- * ATK doc says:\n
- * Gets the number of accessible children of the accessible.
- * @param obj an AtkObject
+ * Implementation of AtkObject->get_n_children callback.
*
- * @returns an integer representing the number of accessible children of
+ * @param obj AtkObject instance
+ *
+ * @returns integer representing the number of accessible children of
* the accessible
*/
static gint
}
/**
- * @brief Implementation AtkObject->ref_child callback
+ * @brief Gets a reference to the specified accessible child of the object.
*
- * ATK doc says:\n
- * Gets a reference to the specified accessible child of the object. The
- * accessible children are 0-based so the first accessible child is at index 0,
+ * The accessible children are 0-based so the first accessible child is at index 0,
* the second at index 1 and so on.
*
- * @param obj an AtkObject
+ * Implementation of AtkObject->ref_child callback.
+ *
+ * @param obj AtkObject instance
* @param i index of child to ref
*
- * @returns an AtkObject representing the specified accessible child of the
- * accessible.
+ * @returns AtkObject representing the specified accessible child of the
+ * accessible
*/
static AtkObject *
eail_notify_ref_child(AtkObject *obj, gint i)
}
/**
- * @brief Initializer for EailNotify GObject class (defines callbacks for
- * base AtkObject)
+ * @brief Initializer for EailNotify GObject class
+ *
+ * Defines callbacks for base AtkObject.
*
- * @param klass an EailNotify class
+ * @param klass EailNotifyClass instance
*/
static void
eail_notify_class_init(EailNotifyClass *klass)
* @brief Macro upcasts an instance (obj) of a subclass to the EailNotify
* type
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_NOTIFY(obj) (G_TYPE_NOTIFY_INSTANCE_CAST((obj), \
EAIL_TYPE_NOTIFY, EailNotify))
/**
* @brief Tests whether object (obj) is an instance of EailNotify class
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_IS_NOTIFY(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), \
EAIL_TYPE_NOTIFY))
/** @brief Definition of object structure for Atk EailNotify*/
struct _EailNotify
{
- /** @brief Parent object that functionality is being extended*/
+ /** @brief Parent widget whose functionality is being extended*/
EailWidget parent;
};
/**
* @file eail_panel.c
- * @brief Implementation of panel widget
+ * @brief EailPanel implementation
*/
#include <atk/atk.h>
#include "eail_panel.h"
/**
- * @brief EailPanel toogle action name
+ * @brief EailPanel 'toggle' action name
*/
#define EAIL_PANEL_TOGGLE_ACTION "toggle"
G_DEFINE_TYPE(EailPanel, eail_panel, EAIL_TYPE_ACTION_WIDGET);
/**
- * @brief Implementation of AtkObject->ref_state_set callback
+ * @brief Gets a reference to the state set of the accessible
*
- * ATK doc says:
- * Gets a reference to the state set of the accessible; the caller must
- * unreference it when it is no longer needed.
+ * The caller must unreference it when it is no longer needed.
*
- * @param obj an AtkObject
+ * Implementation of AtkObject->ref_state_set callback.
*
- * @returns a reference to an AtkStateSet which is the state set of the
- * accessible.
+ * @param obj AtkObject instance
+ *
+ * @returns AtkStateSet representing the state set of the
+ * accessible
*/
static AtkStateSet*
eail_panel_ref_state_set(AtkObject *obj)
}
/**
- * @brief Implementation of eail_widget_get_widget_children callback from
- * EailWidget
+ * @brief Gets accessible children of a panel
+ *
+ * Implementation of eail_widget_get_widget_children callback from
+ * EailWidget.
*
- * @param widget an EailWidget
+ * @param widget EailWidget instance
*
- * @returns Eina_List filled with Evas_Object* objects contained in Panel widget
+ * @returns Eina_List representing a list of the panel widget's children
*/
static Eina_List*
eail_panel_children_get(EailWidget *widget)
}
/**
- * @brief Inits Action interface for PANEL
+ * @brief Initializes the Action interface for panel
*
- * @param action an AtkAction
+ * @param action AtkAction instance
* @param data data passed to callback
* @returns TRUE on success, FALSE otherwise
*/
/**
* @brief Hooks EailPanel actions callbacks
*
- * @param action_widget an EailActionWidget
+ * @param action_widget EailActionWidget instance
*/
static void
eail_panel_actions_init(EailActionWidget *action_widget)
/**
* @brief Initializer for AtkObjectClass
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
* @param data initialization data
*/
static void
/**
* @brief Initializer for GObject class
*
- * @param panel an EailPanel
+ * @param panel EailPanel instance
*/
static void
eail_panel_init(EailPanel *panel)
}
/**
- * @brief Initializer for GObject panel class (defines callbacks for base
- * AtkObject)
+ * @brief Initializer for GObject panel class
+ *
+ * Defines callbacks for base AtkObject.
*
- * @param klass an EailPanel class
+ * @param klass EailPanelClass instance
*/
static void
eail_panel_class_init(EailPanelClass *klass)
* @brief Macro upcasts an instance (obj) of a subclass to the EailPanel
* type
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_PANEL(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), \
EAIL_TYPE_PANEL, EailPanel))
/**
* @brief Tests whether object (obj) is an instance of EailPanel class
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_IS_PANEL(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), \
EAIL_TYPE_PANEL))
/** @brief Definition of object structure for Atk EailPanel*/
struct _EailPanel
{
- EailActionWidget parent;/**< @brief widget that is being extended*/
- char *toggle_description;/**< @brief description for 'toggle' action */
+ EailActionWidget parent;/**< @brief Parent widget whose functionality is being extended*/
+ char *toggle_description;/**< @brief Description of "toggle" action */
};
/** @brief Definition of object class for Atk EailPanel*/
/**
* @brief EailPanes initializer
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
* @param data initialization data
*/
static void
/**
* @brief EailPanes instance initializer
*
- * @param panes an EailPanes
+ * @param panes EailPanes instance
*/
static void
eail_panes_init(EailPanes *panes)
}
/**
- * @brief Gets obj children number
+ * @brief Gets the number of children of obj
*
- * @param obj an AtkObject
- * @returns children number
+ * @param obj AtkObject instance
+ * @returns integer representing the number of children
*/
static gint
eail_panes_n_children_get(AtkObject *obj)
}
/**
- * @brief Gets obj state set
+ * @brief Gets the state set of obj
*
- * @param obj an AtkObject
- * @return obj state set
+ * @param obj AtkObject instance
+ * @return AtkStateSet representing the state set of obj
*/
static AtkStateSet*
eail_panes_ref_state_set(AtkObject *obj)
}
/**
- * @brief Gets obj i-th child reference
+ * @brief Gets the specified child of obj
*
- * The caller must unreference it when it is no longer needed
+ * The caller must unreference it when it is no longer needed.
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
* @param i child index
- * @return child reference
+ * @return AtkObject representing the specified child of obj
*/
static AtkObject*
eail_panes_ref_child(AtkObject *obj, int i)
}
/**
- * @brief an EailPanes class initializer
+ * @brief EailPanes class initializer
*
- * @param klass an EailPanes class
+ * @param klass EailPanesClass instance
*/
static void
eail_panes_class_init(EailPanesClass *klass)
}
/**
- * @brief Gets obj maximum value
+ * @brief Gets the maximum value of obj
*
- * @param obj an AtkValue
- * @param value obj maxiumum value
+ * @param obj AtkValue instance
+ * @param [out] value maxiumum value of obj
*/
static void
eail_panes_maximum_value_get(AtkValue *obj, GValue *value)
}
/**
- * @brief Gets obj minimum value
+ * @brief Gets the minimum value of obj
*
- * @param obj an AtkValue
- * @param value obj minimum value
+ * @param obj AtkValue instance
+ * @param [out] value minimum value of obj
*/
static void
eail_panes_minimum_value_get(AtkValue *obj, GValue *value)
}
/**
- * @brief Sets obj current value
+ * @brief Sets the current value of obj
*
- * @param obj an AtkValue
- * @param value obj new value
+ * @param obj AtkValue instance
+ * @param value new value of obj
* @return TRUE if value is set successfully, FALSE otherwise
*/
static gboolean
}
/**
- * @brief Gets obj current value
+ * @brief Gets the current value of obj
*
- * @param obj an AtkValue
- * @param value obj current value
+ * @param obj AtkValue instance
+ * @param [out] value current value of obj
*/
static void
eail_panes_current_value_get(AtkValue *obj, GValue *value)
/**
* @brief AtkValue interface initializer
*
- * @param iface an AtkValueIface
+ * @param iface AtkValueIface instance
*/
static void
atk_value_interface_init(AtkValueIface *iface)
* @brief Macro upcasts an instance (obj) of a subclass to the EailPanes
* type
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_PANES(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), \
EAIL_TYPE_PANES, EailPanes))
/**
* @brief Tests whether object (obj) is an instance of EailPanes class
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_IS_PANES(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), \
EAIL_TYPE_PANES))
/** @brief Definition of object structure for Atk EailPanes*/
struct _EailPanes
{
- /** @brief Parent object that functionality is being extended*/
+ /** @brief Parent widget whose functionality is being extended*/
EailWidget parent;
};
/**
- * @brief Gets image size
+ * @brief Gets the image size
*
- * @param image an AtkImage
- * @param width photo width
- * @param height photo height
+ * @param image AtkImage instance
+ * @param [out] width photo width or -1 if value cannot be obtained
+ * @param [out] height photo height or -1 if value cannot be obtained
*/
static void
eail_photo_size_get(AtkImage *image, gint *width, gint *height)
/**
* @brief EailPhoto initializer
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
* @param data initialization data
*/
static void
/**
* @brief EailPhoto class initializer
*
- * @param klass an EailPhotoClass
+ * @param klass EailPhotoClass instance
*/
static void
eail_photo_class_init(EailPhotoClass *klass)
/**
* @brief EailPhoto instance initializer
*
- * @param photo an EailPhoto
+ * @param photo EailPhoto instance
*/
static void
eail_photo_init(EailPhoto *photo)
/**
* @brief AtkImage interface initializer
*
- * @param iface an AtkImage interface
+ * @param iface AtkImage interface
*/
static void
atk_image_iface_init(AtkImageIface* iface)
* @brief Macro upcasts an instance (obj) of a subclass to the EailPhoto
* type
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_PHOTO(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), \
EAIL_TYPE_PHOTO, EailPhoto))
/**
* @brief Tests whether object (obj) is an instance of EailPhoto class
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_IS_PHOTO(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), \
EAIL_TYPE_PHOTO))
/** @brief Definition of object structure for Atk EailPhoto*/
struct _EailPhoto
{
- /** @brief Parent object that functionality is being extended*/
+ /** @brief Parent widget whose functionality is being extended*/
EailImage parent;
};
#include "eail_photocam.h"
/**
- * @brief ZoomIn action name
+ * @brief 'zoom in' action name
*/
#define EAIL_PHOTOCAM_ACTION_ZOOM_IN "zoom_in"
/**
- * @brief ZoomOut action name
+ * @brief 'zoom out' action name
*/
#define EAIL_PHOTOCAM_ACTION_ZOOM_OUT "zoom_out"
/**
- * @brief Click action name
+ * @brief 'click' action name
*/
#define EAIL_PHOTOCAM_ACTION_CLICK "click"
atk_image_iface_init));
/**
- * @brief ZoomIn action callback
+ * @brief 'zoom in' action callback
*
- * @param action an AtkAction
+ * @param action AtkAction instance
* @param data data passed to callback
* @return TRUE on success, FALSE otherwise
*/
}
/**
- * @brief ZoomOut action callback
+ * @brief 'zoom out' action callback
*
- * @param action an AtkAction
+ * @param action AtkAction instance
* @param data data passed to callback
* @return TRUE on success, FALSE otherwise
*/
}
/**
- * @brief Click action callback
+ * @brief 'click' action callback
*
- * @param action an AtkAction
+ * @param action AtkAction instance
* @param data data passed to callback
* @return TRUE on success, FALSE otherwise
*/
/**
* @brief EailPhotocam initializer
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
* @param data initialization data
*/
static void
}
/**
- * @brief Gets obj state set
+ * @brief Gets the state set of obj
*
- * The caller must unreference it when it is no longer needed
+ * The caller must unreference it when it is no longer needed.
*
- * @param obj an AtkObject
- * @return obj state set
+ * @param obj AtkObject instance
+ * @return AtkStateSet representing the state set of obj
*/
static AtkStateSet*
eail_photocam_ref_state_set(AtkObject *obj)
/**
* @brief EailPhotocam finalizer
*
- * Frees allocated resources
+ * Frees allocated resources.
*
- * @param object a GObject
+ * @param object GObject instance
*/
static void
eail_photocam_finalize(GObject *object)
/**
* @brief EailPhotocam class initializer
*
- * @param klass an EailPhotocamClass
+ * @param klass EailPhotocamClass instance
*/
static void
eail_photocam_class_init(EailPhotocamClass *klass)
/**
* @brief EailPhotocam instance intializer
*
- * @param photocam an EailPhotocam
+ * @param photocam EailPhotocam instance
*/
static void eail_photocam_init(EailPhotocam *photocam)
{
}
/**
- * @brief Gets image size
+ * @brief Gets the image's size
*
- * @param image an AtkImage
- * @param [out] width image width
- * @param [out] height image height
+ * @param image AtkImage instance
+ * @param [out] width image width or -1 if value cannot be obtained
+ * @param [out] height image height or -1 if value cannot be obtained
*/
static void
eail_photocam_image_size_get(AtkImage *image, gint *width, gint *height)
}
/**
- * @brief Gets image description
+ * @brief Gets the image's description
*
- * @param image an AtkImage
- * @return description
+ * @param image AtkImage instance
+ * @return string representing the image's description
*/
static const char*
eail_photocam_image_description_get(AtkImage* image)
}
/**
- * @brief Sets image description
+ * @brief Sets the image's description
*
- * @param image an AtkImage
+ * @param image AtkImage instance
* @param description new image description
- * @return TRUE if description is set successfully, FALSE otherwise
+ * @return TRUE if description was set successfully, FALSE otherwise
*/
static gboolean
eail_photocam_image_description_set(AtkImage *image, const char *description)
}
/**
- * @brief Gets image position
+ * @brief Gets the image's position
*
- * Position is in the form of a point specifying background top-left corner
+ * Position is in the form of a point specifying background top-left corner.
*
- * @param image an AtkImage
- * @param [out] x x coordinate
- * @param [out] y y coordinate
- * @param coord_type xy coordinate interpretation
+ * @param image AtkImage instance
+ * @param [out] x x coordinate or -1 if value cannot be obtained
+ * @param [out] y y coordinate or -1 if value cannot be obtained
+ * @param coord_type specifies whether the coordinates are relative to the screen
+ * or to the components top level window
*/
static void
eail_photocam_image_position_get(AtkImage *image,
/**
* @brief AktImage interface initializer
*
- * @param iface an AtkImage interface
+ * @param iface AtkImageIface instance
*/
static void
atk_image_iface_init(AtkImageIface *iface)
* @brief Macro upcasts an instance (obj) of a subclass to the EailPhotocam
* type
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_PHOTOCAM(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), \
EAIL_TYPE_PHOTOCAM, EailPhotocam))
/**
* @brief Tests whether object (obj) is an instance of EailPhotocam class
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_IS_PHOTOCAM(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), \
EAIL_TYPE_PHOTOCAM))
/** @brief Definition of object structure for Atk EailPhotocam*/
struct _EailPhotocam
{
- EailScrollableWidget parent;/**< @brief widget that is being extended*/
+ EailScrollableWidget parent;/**< @brief Parent widget whose functionality is being extended*/
char *description;/**< @brief 'description' string property*/
};
/**
* @brief EailPlug object initialization
*
- * @param obj EailPlug object
+ * @param obj AtkObject instance
* @param data user set additional initialization data
*/
static void
/**
* @brief Class destructor
*
- * @param object object instance
+ * @param object GObject instance
*/
static void
eail_plug_finalize(GObject *object)
/**
* @brief GObject type initialization function
*
- * @param klass EailPlug class
+ * @param klass EailPlugClass instance
*/
static void
eail_plug_class_init(EailPlugClass *klass)
*/
/**
- * @brief Implementation of get_n_actions from AtkAction interface
+ * @brief Gets the number of accessible actions available on the object
*
- * @param action EailPlug instance
+ * If there are more than one, the first one is considered
+ * the "default" action of the object.
*
- * @returns number of actions supported by EailPlug
+ * Implementation of get_n_actions from AtkAction interface.
+ *
+ * @param action AtkAction instance
+ *
+ * @returns integer representing the number of actions supported by EailPlug
*/
static int
eail_plug_n_actions_get(AtkAction *action)
}
/**
- * @brief Implementation of get_description from AtkAction interface
+ * @brief Gets the description of specified action of the object
+ *
+ * Implementation of get_description from AtkAction interface.
*
- * @param action EailPlug instance
+ * @param action AtkAction instance
* @param i action index
*
- * @return action description
+ * @return string representing the description of the specified action
*/
static const char*
eail_plug_description_get(AtkAction *action,
}
/**
- * @brief Implementation of set_description from AtkAction interface
+ * @brief Sets a description of the specified action of the object
*
- * @param action EailPlug instance
+ * Implementation of set_description from AtkAction interface.
+ *
+ * @param action AtkAction instance
* @param i action index
* @param description action description
*
}
/**
- * @brief Implementation of get_name from AtkAction interface
+ * @brief Gets the name of the specified action of the object
+ *
+ * Implementation of get_name from AtkAction interface.
*
- * @param action EailPlug instance
+ * @param action AtkAction instance
* @param i action index
*
- * @return action name
+ * @return string representing the name of the specified action
*/
static const char*
eail_plug_action_name_get(AtkAction *action,
}
/**
- * @brief Implementation of do_action from AtkAction interface
+ * @brief Performs the specified action on the object
+ *
+ * Implementation of do_action from AtkAction interface.
*
- * @param action EailPlug instance
+ * @param action AtkAction instance
* @param i action index
*
* @return TRUE on success, FALSE otherwise
/**
* @brief AtkAction interface initializer
*
- * @param iface an AtkAction interface
+ * @param iface AtkAction interface
*/
static void
atk_action_interface_init(AtkActionIface *iface)
* @brief Macro upcasts an instance (obj) of a subclass to the EailPlug
* type
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_PLUG(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), \
EAIL_TYPE_PLUG, EailPlug))
/**
* @brief Tests whether object (obj) is an instance of EailPlug class
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_IS_PLUG(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), \
EAIL_TYPE_PLUG))
/** @brief Definition of object structure for Atk EailPlug*/
struct _EailPlug
{
- /** @brief Parent object that functionality is being extended*/
+ /** @brief Parent widget whose functionality is being extended*/
EailWidget parent;
char *click_description; /*!< @brief 'click' action description*/
/**
* @file eail_popup.c
- * @brief Implementation of popup widget
+ * @brief EailPopup implementation
*/
#include <atk/atk.h>
*/
#define EAIL_POPUP_BUTTON_FORMAT "button%d"
/**
- * @brief number of popup buttons
+ * @brief Number of popup buttons
*/
#define EAIL_POPUP_NUM_BUTTONS 3
/**
/**
* @brief Initializer for AtkObject
- * @param obj an AtkObject
+ *
+ * @param obj AtkObject instance
* @param data initialization data
*/
static void
/**
* @brief EailPopup GObject instance initializer
- * @param button an EailPopup
+ *
+ * @param button EailPopup instance
*/
static void
eail_popup_init(EailPopup *button)
}
/**
- * @brief Helper function to getting "elm_popup" Evas_Object* from Atk EailPopup
+ * @brief Helper function for getting elm_popup Evas_Object* from Atk EailPopup
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*
- * @returns nested "elm_popup" widget
+ * @returns Evas_Object representing the nested elm_popup widget
*/
static Evas_Object *
_eail_get_popup_widget_from_atkobj(AtkObject *obj)
}
/**
- * @brief Helper function to getting nested content in "elm_popup" widget
+ * @brief Helper function for getting nested content in elm_popup widget
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*
- * @returns nested widget content from "elm_popup" widget
+ * @returns Evas_Object representing the nested widget content from elm_popup widget
*/
static Evas_Object *
_eail_get_nested_widget(AtkObject *obj)
}
/**
- * @brief Helper function to getting nested button content in "elm_popup" widget
+ * @brief Helper function for getting nested button content in elm_popup widget
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
* @param index index of button in popup widget
*
- * @returns nested button widget from "elm_popup" widget or NULL if failed
+ * @returns Evas_Object representing the nested button widget
+ * from elm_popup widget or NULL in case of a failure
*/
static Evas_Object *
_eail_get_nested_popup_button(AtkObject *obj, gint index)
* @brief Prepares Eina_List filled with Evas_Object * objects
* representing nested content in elm_popup widget
*
- * @param obj an AtkObject
+ * Call eina_list_free on the returned list when results processing has been finished.
+ *
+ * @param obj AtkObject instance
*
- * @return filled list with Evas_Object* objects. Call eina_list_free on that
- * list when results processing has been finished
+ * @return Eina_List representing the list of Evas_Object* objects
*/
static Eina_List *
_eail_popup_get_items(AtkObject *obj)
}
/**
- * @brief Implementation AtkObject->get_n_children callback
+ * @brief Gets the number of accessible children of the accessible
*
- * ATK doc says:\n
- * Gets the number of accessible children of the accessible.
- * @param obj an AtkObject
+ * Implementation of AtkObject->get_n_children callback.
*
- * @returns an integer representing the number of accessible children of
+ * @param obj AtkObject instance
+ *
+ * @returns integer representing the number of accessible children of
* the accessible
*/
static gint
}
/**
- * @brief Implementation AtkObject->ref_child callback
+ * @brief Gets a reference to the specified accessible child of the object.
*
- * ATK doc says:\n
- * Gets a reference to the specified accessible child of the object. The
- * accessible children are 0-based so the first accessible child is at index 0,
+ * The accessible children are 0-based so the first accessible child is at index 0,
* the second at index 1 and so on.
*
- * @param obj an AtkObject
+ * Implementation of AtkObject->ref_child callback.
+ *
+ * @param obj AtkObject instance
* @param i index of a child
*
- * @returns an AtkObject representing the specified accessible child of the
- * accessible.
+ * @returns AtkObject representing the specified accessible child of the
+ * accessible
*/
static AtkObject *
eail_popup_ref_child(AtkObject *obj, gint i)
}
/**
- * @brief Gets name of EailItem
- *
- * Implementation of AtkObject->get_name callback
+ * @brief Gets the accessible name of EailItem
*
- * ATK doc says:\n
- * Gets the accessible name of the accessible.
+ * Implementation of AtkObject->get_name callback.
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*
- * @returns a character string representing the accessible description of
- * the accessible.
+ * @returns character string representing the accessible description of
+ * the accessible
*/
static const gchar *
eail_popup_get_name(AtkObject *obj)
/**
* @brief Destructor for EailPopup class
+ * @param object GObject instance
*/
static void
eail_popup_finalize(GObject *object)
}
/**
- * @brief Initializer for EailPopup GObject class (defines callbacks for
- * base AtkObject)
+ * @brief Initializer for EailPopup GObject class
+ *
+ * Defines callbacks for base AtkObject.
+ *
+ * @param klass EailPopupClass instance
*/
static void
eail_popup_class_init(EailPopupClass *klass)
/**
* @brief Helper function that gets text from popup as Eina_Strbuf*
*
- * @param popup an EailPopup instance
+ * @param popup AtkText instance
*
- * @returns Eina_Strbuf* object with filled text content of a popup
+ * @returns Eina_Strbuf representing the text content of the popup
*/
static Eina_Strbuf *
_eail_popup_get_strbuf(AtkText *popup)
}
/**
- * @brief Gets text content from popup
+ * @brief Gets the text content from popup
*
- * Implementation of AtkTextIface->get_text callback\n
+ * Use g_free() to free the returned string.
*
- * @param popup an AtkText
+ * Implementation of AtkTextIface->get_text callback.
+ *
+ * @param popup AtkText instance
* @param start_offset start position
* @param end_offset end position, or -1 for the end of the string.
*
- * @returns a newly allocated string containing the text from start_offset
- * up to, but not including end_offset. Use g_free() to free the returned
- * string.
+ * @returns newly allocated string containing the text from start_offset
+ * up to, but not including end_offset
*/
static gchar*
eail_popup_get_text(AtkText *popup,
}
/**
- * @brief Gets character from popup at given offset
+ * @brief Gets the character from popup at given offset
*
- * Implementation of AtkTextIface->get_character_at_offset callback
+ * Implementation of AtkTextIface->get_character_at_offset callback,
*
- * @param popup an AtkText
- * @param offset an offset
+ * @param popup AtkText instance
+ * @param offset offset
*
- * @returns the character at offset.
+ * @returns char representing the character at offset
*/
static gunichar
eail_popup_get_character_at_offset(AtkText *popup, gint offset)
}
/**
- * @brief Gets character count from text content in popup<br>
- * Implementation of AtkTextIface->get_character_count callback
+ * @brief Gets the character count from text content in popup
+ *
+ * Implementation of AtkTextIface->get_character_count callback.
*
- * @param popup an AtkText
+ * @param popup AtkText instance
*
- * @returns the character count
+ * @returns char representing the the character count
*/
static gint
eail_popup_get_character_count(AtkText *popup)
}
/**
- * @brief Initializer for AtkTextIface interface class (defines callbacks for
- * AtkTextIface)
+ * @brief Initializer for AtkTextIface interface class
+ *
+ * Defines callbacks for AtkTextIface.
*
- * @param iface an AtkText interface
+ * @param iface AtkTextIface instance
*/
static void
atk_text_interface_init(AtkTextIface *iface)
* @brief Macro upcasts an instance (obj) of a subclass to the EailPopup
* type
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_POPUP(obj) (G_TYPE_POPUP_INSTANCE_CAST((obj), \
EAIL_TYPE_POPUP, \
/**
* @brief Tests whether object (obj) is an instance of EailPopup class
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_IS_POPUP(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), \
EAIL_TYPE_POPUP))
/** @brief Definition of object structure for Atk EailPopup*/
struct _EailPopup
{
- /** @brief Parent object that functionality is being extended*/
+ /** @brief Parent widget whose functionality is being extended*/
EailNotify parent;
};
/**
* @file eail_prefs.c
- * @brief EailPrefs widget implementation.
+ * @brief EailPrefs implementation
*/
#include <Elementary.h>
G_DEFINE_TYPE(EailPrefs, eail_prefs, EAIL_TYPE_WIDGET);
/**
- * @brief EailPrefs initializer.
+ * @brief EailPrefs initializer
*
- * @param obj EailPrefs instance
+ * @param obj AtkObject instance
* @param data initialization data
*/
static void
}
/**
- * @brief Gets children for prefs object
+ * @brief Gets the list of children of the prefs object
*
* @param parent parent widget
- * @param items empty list (used as output value)
+ * @param [out] items list of object's children
*/
static void eail_prefs_children_get(Evas_Object *parent,
Eina_List **items)
}
/**
- * @brief Gets list of children for given widget
+ * @brief Gets the list of children for the specified widget
*
- * @param widget an EailWidget (EailPrefs) to take children from
+ * @param widget EailWidget instance
*
- * @returns filled Eina_List with widget children or NULL if no children found
+ * @returns Eina_List representing the widget's children
+ * or NULL if the widget's has no children
*/
static Eina_List *
eail_prefs_get_widget_children(EailWidget *widget)
}
/**
- * @brief EailPrefs class initializer.
+ * @brief EailPrefs class initializer
*
- * Here basic callbacks for AtkObject are defined
+ * Definition of basic callbacks for AtkObject.
*
- * @param klass EailPrefs class
+ * @param klass EailPrefsClass instance
*/
static void
eail_prefs_class_init(EailPrefsClass *klass)
* @brief Macro upcasts an instance (obj) of a subclass to the EailPrefs
* type
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_PREFS(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), \
EAIL_TYPE_PREFS, EailPrefs))
/**
* @brief Tests whether object (obj) is an instance of EailPrefs class
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_IS_PREFS(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), \
EAIL_TYPE_PREFS))
/** @brief Definition of object structure for Atk EailPrefs*/
struct _EailPrefs
{
- /** @brief Parent object that functionality is being extended*/
+ /** @brief Parent widget whose functionality is being extended*/
EailWidget parent;
};
*/
/**
- * @brief handler for changed event
+ * @brief Handler for changed event
*
- * @param data passed to callback
- * @param obj object that raised event
+ * @param data data passed to callback
+ * @param obj Evas_Object that raised event
* @param event_info additional event info
*/
void
/**
* @brief EailProgressbar object initialization
*
- * @param obj EailProgressbar object
+ * @param obj AtkObject instance
* @param data user set additional initialization data
*/
static void
}
/**
- * @brief Gets list of child widget
+ * @brief Gets the list of child widgets
*
* @param widget EailWidget object
*
- * @return list of child, NULL if no children
+ * @return Eina_List representing the list of widget's children
+ * or NULL if widget has no children
*/
static Eina_List *
eail_progressbar_get_widget_children(EailWidget *widget)
}
/**
- * @brief Gets slider name
+ * @brief Gets the slider's name
*
- * @param obj EailSlider instance
- * @returns accessible name
+ * @param obj AtkObject instance
+ * @returns string representing the accessible name of the slider
*/
static const gchar*
eail_progressbar_get_name(AtkObject *obj)
/**
* @brief GObject type initialization function
*
- * @param klass EailProgressbar class
+ * @param klass EailProgressbarClass instance
*/
static void
eail_progressbar_class_init(EailProgressbarClass *klass)
*/
/**
- * @brief Gets obj current value
+ * @brief Gets the current value of obj
*
- * @param obj EailProgressbar instance
- * @param value EailProgressbar current value
+ * @param obj AtkValue instance
+ * @param [out] value obj's current value
*/
static void
eail_progressbar_get_current_value(AtkValue *obj,
}
/**
- * @brief Gets obj maxiumum value
+ * @brief Gets the maxiumum value of obj
*
- * @param obj EailProgressbar instance
- * @param value EailProgressbar maxiumum value
+ * @param obj AtkValue instance
+ * @param [out] value obj's maxiumum value
*/
static void
eail_progressbar_get_maximum_value(AtkValue *obj,
}
/**
- * @brief Gets obj minimum value
+ * @brief Gets the minimum value of obj
*
- * @param obj EailProgressbar instance
- * @param value EailProgressbar minimum value
+ * @param obj AtkValue instance
+ * @param [out] value obj's minimum value
*/
static void
eail_progressbar_get_minimum_value(AtkValue *obj,
}
/**
- * @brief Sets obj value
+ * @brief Sets the value of obj
*
- * @param obj EailProgressbar instance
- * @param value EailProgressbar new value
+ * @param obj AtkValue instance
+ * @param value obj's new value
* @return TRUE if new value is set successfully, FALSE otherwise
*/
static gboolean
}
/**
- * @brief Gets obj minimum increment
+ * @brief Gets the minimum increment of obj
*
- * @param obj EailProgressbar instance
- * @param value EailProgressbar minimum increment
+ * @param obj AtkValue instance
+ * @param [out] value obj's minimum increment
*/
static void
eail_progressbar_get_minimum_increment(AtkValue *obj,
/**
* @brief AtkValue interface initializer
*
- * @param iface an AtkValue interface
+ * @param iface AtkValueIface instance
*/
static void
atk_value_interface_init(AtkValueIface *iface)
* @brief Macro upcasts an instance (obj) of a subclass to the EailProgressbar
* type
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_PROGRESSBAR(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), \
EAIL_TYPE_PROGRESSBAR, EailProgressbar))
/**
* @brief Tests whether object (obj) is an instance of EailProgressbar class
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_IS_PROGRESSBAR(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), \
EAIL_TYPE_PROGRESSBAR))
/** @brief Definition of object structure for Atk EailProgressbar*/
struct _EailProgressbar
{
- /** @brief Parent object that functionality is being extended*/
+ /** @brief Parent widget whose functionality is being extended*/
EailWidget parent;
};
/**
* @file eail_radio_button.c
- * @brief Implementation of EailRadioButton object
+ * @brief EailRadioButton implementation
*/
#include <atk/atk.h>
atk_action_interface_init));
/**
- * @brief Callback for on_change event
- * We be called to notify AtkObject about state change
+ * @brief Callback for 'on_change' event
+ *
+ * Called to notify AtkObject about state change.
*
* @param data user data passed to callback
* @param obj source object
}
/**
- * @brief Implementation of ref_state_set from AtkObject interface
+ * @brief Gets a reference to the state set of the accessible
+ *
+ * The caller must unreference it when it is no longer needed.
+ *
+ * Implementation of ref_state_set from AtkObject interface.
*
- * @param obj EailRadioButton instance
+ * @param obj AtkObject instance
*
- * @returns state of AtkObject
+ * @returns AtkStateSet representing the state set of the accessible
*/
static AtkStateSet*
eail_radio_button_ref_state_set(AtkObject *obj)
/**
* @brief Initialize EailRadionButton as AtkObject
*
- * @param obj EailRadioButton instance
+ * @param obj AtkObject instance
* @param data user data passed to initialization
*/
static void
/**
* @brief EailRadioButton finalize function
*
- * @param object EailRadioButton instance
+ * @param object GObject instance
*/
static void
eail_radio_button_finalize(GObject *object)
/**
* @brief Object class initialization
*
- * @param klass EailRadioButton class
+ * @param klass EailRadioButtonClass instance
*/
static void
eail_radio_button_class_init(EailRadioButtonClass *klass)
}
/**
- * @brief Implementation of get_n_actions from AtkAction interface
+ * @brief Gets the number of accessible actions available on the object
+ *
+ * If there are more than one, the first one is considered
+ * the "default" action of the object.
+ *
+ * Implementation of get_n_actions from AtkAction interface.
*
- * @param action EailRadioButton instance
+ * @param action AtkAction instance
*
- * @returns number of actions
+ * @returns integer representing the number of available actions
*/
static int
eail_radio_button_n_action_get(AtkAction *action)
}
/**
- * @brief Implementation of get_action_name from AtkAction interface
+ * @brief Gets the name of the specified action of the object
*
- * @param action EailRadioButton instance
+ * Implementation of get_action_name from AtkAction interface.
+ *
+ * @param action AtkAction instance
* @param i index of action
*
- * @returns action name
+ * @returns string representing the name of the specified action
*/
static const char*
eail_radio_button_action_name_get(AtkAction *action, int i)
}
/**
- * @brief Implementation of set_description from AtkAction
+ * @brief Sets a description of the specified action of the object
+ *
+ * Implementation of set_description from AtkAction.
*
- * @param action EailRadioButton instance
+ * @param action AtkAction instance
* @param i action index
- * @param description action description to set
+ * @param description action's description to set
*
- * @returns TRUE on success FALSE otherwise
+ * @returns TRUE on success, FALSE otherwise
*/
static gboolean
eail_radio_button_description_set(AtkAction *action, gint i, const char *description)
}
/**
- * @brief Implementation of get_description from AtkAction interface
+ * @brief Gets the description of the specified action of the object
*
- * @param action EailRadioButton instance
+ * Implementation of get_description from AtkAction interface.
+ *
+ * @param action AtkAction instance
* @param i index of action
*
- * @returns action descritpion
+ * @returns string representing the description of the specified action
*/
static const char*
eail_radio_button_description_get(AtkAction *action, gint i)
}
/**
- * @brief Implementation of set_description from AtkAction interface
+ * @brief Performs the specified action on the object
+ *
+ * Implementation of do_action from AtkAction interface.
*
- * @param action EailRadioButton instance
+ * @param action AtkAction instance
* @param i action index
*
- * @returns TRUE on success FALSE otherwise
+ * @returns TRUE on success, FALSE otherwise
*/
static gboolean
eail_radio_button_do_action(AtkAction *action, int i)
/**
* @brief AtkAction interface initialization
*
- * @param iface EailRadioButton object
+ * @param iface AtkActionIface instance
*/
static void
atk_action_interface_init(AtkActionIface *iface)
* @brief Macro upcasts an instance (obj) of a subclass to the EailRadiobutton
* type
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_RADIO_BUTTON(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj),\
EAIL_TYPE_RADIO_BUTTON, \
/**
* @brief Tests whether object (obj) is an instance of EailRadiobutton class
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_IS_RADIO_BUTTON(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj),\
EAIL_TYPE_RADIO_BUTTON))
/** @brief Definition of object structure for Atk EailRadiobutton*/
struct _EailRadioButton
{
- /** @brief Parent object that functionality is being extended*/
+ /** @brief Parent widget whose functionality is being extended*/
EailButton parent;
char *click_description; /*!< @brief 'click' action description*/
- Eina_Bool state; /*!< @brief state of object (selected/unselected)*/
+ Eina_Bool state; /*!< @brief State of object (selected/unselected)*/
};
/** @brief Definition of object class for Atk EailRadiobutton*/
/**
* @brief EailRoute object initialization
*
- * @param obj EailRoute object
+ * @param obj AtkObject instance
* @param data user set additional initialization data
*/
static void
/**
* @brief GObject type initialization function
*
- * @param klass EailRoute class
+ * @param klass EailRouteClass instance
*/
static void
eail_route_class_init(EailRouteClass *klass)
*/
/**
- * @brief Gets obj current value
+ * @brief Gets the current value of obj
*
- * @param obj EailRoute instance
- * @param value EailRoute current value
+ * @param obj AtkValue instance
+ * @param [out] value obj's current value
*/
static void
eail_route_get_current_value(AtkValue *obj,
/**
* @brief AtkValue interface initialization
*
- * @param iface an AtkValue interface
+ * @param iface AtkValueIface instance
*/
static void
atk_value_interface_init(AtkValueIface *iface)
* @brief Macro upcasts an instance (obj) of a subclass to the EailRoute
* type
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_ROUTE(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), \
EAIL_TYPE_ROUTE, EailRoute))
/**
* @brief Tests whether object (obj) is an instance of EailRoute class
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_IS_ROUTE(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), \
EAIL_TYPE_ROUTE))
/** @brief Definition of object structure for Atk EailRoute*/
struct _EailRoute
{
- /** @brief Parent object that functionality is being extended*/
+ /** @brief Parent widget whose functionality is being extended*/
EailWidget parent;
};
* @brief Definition of EailScrollableWidget as GObject
*
* NOTE: this class extends EAIL_TYPE_ACTION_WIDGET, which implements
- * all needed functions for ATK_ACTION interface so additional implementing
+ * all needed functions for ATK_ACTION interface so additional implementing of
* ATK_ACTION interface here is not needed.
- * Only what is really needed, is to call:
+ * Only thing that is really needed is to call:
* eail_action_widget_action_append(...) to register all needed additional
* actions
*/
EAIL_TYPE_ACTION_WIDGET);
/**
- * @brief Handler for scroll event
+ * @brief Handler for 'scroll' event
*
- * @param data passed to callback
- * @param obj object that raised event
+ * @param data data passed to callback
+ * @param obj Evas_Object that raised event
* @param event_info additional event info
*/
static void
/**
* @brief Initializer for GObject class
*
- * @param scrollable_widget an EailScrollableWidget
+ * @param scrollable_widget EailScrollableWidget instance
*/
static void
eail_scrollable_widget_init(EailScrollableWidget *scrollable_widget)
/**
* @brief Finalize function for GObject
*
- * @param object GObject object instance to finalize
+ * @param object GObject instance to finalize
*/
static void
eail_scrollable_widget_finalize(GObject *object)
/**
- * @brief Scrollup action callback
+ * @brief 'scroll up' action callback
*
- * @param action an AtkAction
+ * @param action AtkAction instance
* @param data additional callback data
* @returns TRUE on success, FALSE otherwise
*/
}
/**
- * @brief Scrolldown action callback
+ * @brief 'scroll down' action callback
*
- * @param action an AtkAction
+ * @param action AtkAction instance
* @param data additional callback data
* @returns TRUE on success, FALSE otherwise
*/
}
/**
- * @brief Scrollleft action callback
+ * @brief 'scroll left' action callback
*
- * @param action an AtkAction
+ * @param action AtkAction instance
* @param data additional callback data
* @returns TRUE on success, FALSE otherwise
*/
}
/**
- * @brief Scrollright action callback
+ * @brief 'scroll right' action callback
*
- * @param action an AtkAction
+ * @param action AtkAction instance
* @param data additional callback data
* @returns TRUE on success, FALSE otherwise
*/
/**
* @brief Initializer for AtkObjectClass
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
* @param data initialization data
*/
static void
}
/**
- * @brief Init function for GObject
+ * @brief Initializer for GObject
*
- * @param klass an EailScrollableWidget class
+ * @param klass EailScrollableWidgetClass instance
*/
static void
eail_scrollable_widget_class_init(EailScrollableWidgetClass *klass)
* @brief Macro upcasts an instance (obj) of a subclass to the EailScrollableWidget
* type
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_SCROLLABLE_WIDGET(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), \
EAIL_TYPE_SCROLLABLE_WIDGET, \
/**
* @brief Tests whether object (obj) is an instance of EailScrollableWidget class
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_IS_SCROLLABLE_WIDGET(obj) \
(G_TYPE_CHECK_INSTANCE_TYPE((obj), \
/** @brief Definition of object structure for Atk EailScrollableWidget*/
struct _EailScrollableWidget
{
- /** @brief Parent object that functionality is being extended*/
+ /** @brief Parent widget whose functionality is being extended*/
EailActionWidget parent;
};
/**
* @file eail_scroller.c
- * @brief Scroller implementation
+ * @brief EailScroller implementation
*/
#include <Eina.h>
/**
* @brief Initializer for AtkObjectClass
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
* @param data initialization data
*/
static void
* @brief Prepares Eina_List filled with Evas_Object* objects
* representing content of the widget
*
- * @param widget an EailWidget
+ * Call eina_list_free on the returned list when results processing has been finished.
*
- * @return filled list with list items. Call eina_list_free on that list when
- * results processing has been finished
+ * @param widget EailWidget instance
+ *
+ * @return Eina_List representing the list of the widget's children
*/
static Eina_List *
eail_scroller_get_widget_children(EailWidget *widget)
}
/**
- * @brief Gets name of EailItem
- *
- * Implementation of AtkObject->get_name callback
+ * @brief Gets the accessible name of the accessible
*
- * ATK doc says:\n
- * Gets the accessible name of the accessible.
+ * Implementation of AtkObject->get_name callback.
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*
- * @returns a character string representing the accessible description of
- * the accessible.
+ * @returns string representing the accessible name of
+ * the accessible
*/
static const gchar*
eail_scroller_get_name(AtkObject *obj)
/**
* @brief EailFileselector GObject instance initializer
*
- * @param scroller an EailScroller
+ * @param scroller EailScroller instance
*/
static void
eail_scroller_init(EailScroller *scroller)
}
/**
- * @brief Initializer for EailScroller GObject class (defines callbacks for
- * base AtkObject)
+ * @brief Initializer for EailScroller GObject class
+ *
+ * Defines callbacks for base AtkObject.
*
- * @param klass an EailScroller class
+ * @param klass EailScrollerClass instance
*/
static void
eail_scroller_class_init(EailScrollerClass *klass)
* @brief Macro upcasts an instance (obj) of a subclass to the EailScroller
* type
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_SCROLLER(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), \
EAIL_TYPE_SCROLLER, EailScroller))
/**
* @brief Tests whether object (obj) is an instance of EailScroller class
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_IS_SCROLLER(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), \
EAIL_TYPE_SCROLLER))
/** @brief Definition of object structure for Atk EailScroller*/
struct _EailScroller
{
- /** @brief Parent object that functionality is being extended*/
+ /** @brief Parent widget whose functionality is being extended*/
EailScrollableWidget parent;
};
/**
* @file eail_segment_control.c
- * @brief Implementation of Segment Control widget
+ * @brief EailSegmentControl implementation
*/
#include <atk/atk.h>
/**
* @brief Initializer for AtkObjectClass
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
* @param data additional initialization data
*/
static void
/**
* @brief Initializer for GObject class
*
- * @param segment_control an EailSegmentControl
+ * @param segment_control EailSegmentControl instance
*/
static void
eail_segment_control_init(EailSegmentControl *segment_control)
}
/**
- * @brief Implementation AtkObject->get_n_children callback
+ * @brief Gets the number of accessible children of the accessible
*
- * ATK doc says:\n
- * Gets the number of accessible children of the accessible.
+ * Implementation of AtkObject->get_n_children callback.
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*
- * @returns an integer representing the number of accessible children of
+ * @returns integer representing the number of accessible children of
* the accessible
*/
static gint
}
/**
- * @brief Implementation AtkObject->ref_child callback
+ * @brief Gets a reference to the specified accessible child of the object.
*
- * ATK doc says:\n
- * Gets a reference to the specified accessible child of the object. The
- * accessible children are 0-based so the first accessible child is at index 0,
- * the second at index 1 and so on.
+ * The accessible children are 0-based so the first accessible child is
+ * at index 0, the second at index 1 and so on.
*
- * @param obj an AtkObject
+ * Implementation AtkObject->ref_child callback.
+ *
+ * @param obj AtkObject instance
* @param i child index
*
- * @returns an AtkObject representing the specified accessible child of the
- * accessible.
+ * @returns AtkObject representing the specified accessible child of the
+ * accessible
*/
static AtkObject *
eail_segment_control_ref_child(AtkObject *obj, gint i)
/**
* @brief Destructor for Segment Control object
- * @param object a GObject
+ * @param object GObject instance
*/
static void
eail_segment_control_finalize(GObject *object)
}
/**
- * @brief Initializer for GObject EailSegmentControl class (defines callbacks
- * for base AtkObject)
+ * @brief Initializer for GObject EailSegmentControl class
+ *
+ * Defines callbacks for base AtkObject.
*
- * @param klass an EailSegmentControl class
+ * @param klass EailSegmentControlClass instance
*/
static void
eail_segment_control_class_init(EailSegmentControlClass *klass)
}
/**
- * @brief Implementation of AtkSelection->add_selection callback
+ * @brief Adds the specified accessible child of the object to the object's selection
*
- * As described in ATK doc:\n
- * Adds the specified accessible child of the object to the object's selection.
+ * Implementation of AtkSelection->add_selection callback.
*
- * @param selection an AtkSelection
+ * @param selection AtkSelection instance
* @param i index of object
*
- * @returns TRUE if operation ended successfully, FALSE otherwise
+ * @returns TRUE on success, FALSE otherwise
*/
static gboolean
eail_selection_add_selection(AtkSelection *selection,
}
/**
- * @brief Implementation of AtkSelection->clear_selection callback
+ * @brief Clears the selection in the object so that no children in the object are
+ * selected
*
- * As described in ATK doc:\n
- * Clears the selection in the object so that no children in the object are
- * selected.
+ * Implementation of AtkSelection->clear_selection callback.
*
- * @param selection an AtkSelection
+ * @param selection AtkSelection instance
*
- * @returns TRUE if success, FALSE otherwise.
+ * @returns TRUE on success, FALSE otherwise
*/
static gboolean
eail_selection_clear_selection(AtkSelection *selection)
}
/**
- * @brief Implementation of AtkSelection->ref_selection callback
+ * @brief Gets a reference to the accessible object representing the specified selected
+ * child of the object.
*
- * As described in ATK doc:\n
- * Gets a reference to the accessible object representing the specified selected
- * child of the object. Note: callers should not rely on NULL or on a zero value
+ * Note: callers should not rely on NULL or on a zero value
* for indication of whether AtkSelectionIface is implemented, they should use
* type checking/interface checking macros or the atk_get_accessible_value()
* convenience method.
*
- * @param selection an AtkSelection
+ * Implementation of AtkSelection->ref_selection callback.
+ *
+ * @param selection AtkSelection instance
* @param i index of object
*
- * @returns an AtkObject representing the selected accessible , or NULL if
+ * @returns AtkObject representing the selected accessible or NULL if
* selection does not implement this interface
*/
static AtkObject *
}
/**
- * @brief Implementation of AtkSelection->get_selection_count callback
+ * @brief Gets the number of accessible children currently selected.
*
- * As described in ATK doc:\n
- * Gets the number of accessible children currently selected. Note: callers
- * should not rely on NULL or on a zero value for indication of whether
- * AtkSelectionIface is implemented, they should use type checking/interface
- * checking macros or the atk_get_accessible_value() convenience method.
-
- * @param selection an AtkSelection
+ * Note: callers should not rely on NULL or on a zero value for indication
+ * of whether AtkSelectionIface is implemented, they should use type
+ * checking/interface checking macros or the atk_get_accessible_value()
+ * convenience method.
*
- * @returns gint representing number of selected elements
+ * Implementation of AtkSelection->get_selection_count callback.
+ *
+ * @param selection AtkSelection instance
+ *
+ * @returns integer representing the number of selected elements
*/
static gint
eail_selection_get_selection_count(AtkSelection *selection)
}
/**
- * @brief Implementation of AtkSelection->is_child_selected callback
+ * @brief Determines if the current child of this object is selected.
+ *
+ * Note: callers should not rely on NULL or on a zero value for indication
+ * of whether AtkSelectionIface is implemented, they should use type
+ * checking/interface checking macros or the atk_get_accessible_value()
+ * convenience method.
*
- * As described in ATK doc:\n
- * Determines if the current child of this object is selected Note: callers
- * should not rely on NULL or on a zero value for indication of whether
- * AtkSelectionIface is implemented, they should use type checking/interface
- * checking macros or the atk_get_accessible_value() convenience method.
+ * Implementation of AtkSelection->is_child_selected callback.
*
- * @param selection an AtkSelection
+ * @param selection AtkSelection instance
* @param i index of object
*
- * @returns a gboolean representing if the specified child is selected, or
- * FALSE if selection does not implement this interface.
+ * @returns gboolean representing whether the specified child is selected or
+ * FALSE if selection does not implement this interface
*/
static gboolean
eail_selection_is_child_selected(AtkSelection *selection,
}
/**
- * @brief Implementation of AtkSelection->remove_selection callback
+ * @brief Removes the specified child of the object from the object's selection
*
- * As described in ATK doc:\n
- * Removes the specified child of the object from the object's selection.
+ * Implementation of AtkSelection->remove_selection callback.
*
- * @param selection an AtkSelection
+ * @param selection AtkSelection instance
* @param i selection index
*
- * @returns TRUE if success, FALSE otherwise.
+ * @returns TRUE on success, FALSE otherwise
*/
static gboolean
eail_selection_remove_selection(AtkSelection *selection,
}
/**
- * @brief Implementation of AtkSelection->select_all_selection callback
+ * @brief Causes every child of the object to be selected if the object supports
+ * multiple selections
*
- * As described in ATK doc:\n
- * Causes every child of the object to be selected if the object supports
- * multiple selections.
+ * Implementation of AtkSelection->select_all_selection callback.
*
- * @param selection an AtkSelection
+ * @param selection AtkSelection instance
*
- * @returns TRUE if success, FALSE otherwise.
+ * @returns TRUE on success, FALSE otherwise
*/
static gboolean
eail_selection_select_all_selection(AtkSelection *selection)
/**
* @brief Initializer of AtkSelectionIface interface
*
- * @param iface an AtkSelection interface
+ * @param iface AtkSelection interface
*/
static void atk_selection_interface_init(AtkSelectionIface *iface)
{
}
/**
- * @brief Get name of segment control child
+ * @brief Get the name of a segment control's child
*
- * @param parent instance
- * @param item child instance
+ * @param parent EailIemParent instance
+ * @param item EailItem instance
*
- * @returns const gchar * representing name of the child
+ * @returns string representing the name of the child
*/
static const gchar *
eail_segment_control_item_name_get(EailItemParent *parent, EailItem *item)
}
/**
- * @brief Initialization for EailItemParentIface interface
+ * @brief Initialization of EailItemParentIface interface
*
- * @param iface an EailItemParent interface
+ * @param iface EailItemParent interface
*/
static void
eail_item_parent_interface_init(EailItemParentIface *iface)
* @brief Macro upcasts an instance (obj) of a subclass to the EailSegmentControl
* type
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_SEGMENT_CONTROL(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), \
EAIL_TYPE_SEGMENT_CONTROL, \
/**
* @brief Tests whether object (obj) is an instance of EailSegmentControl class
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_IS_SEGMENT_CONTROL(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), \
EAIL_TYPE_SEGMENT_CONTROL))
/** @brief Definition of object structure for Atk EailSegmentControl*/
struct _EailSegmentControl
{
- /** @brief Parent object that functionality is being extended*/
+ /** @brief Parent widget whose functionality is being extended*/
EailWidget parent;
};
/**
* @file eail_separator.c
- * @brief EailSeparator implementation.
+ * @brief EailSeparator implementation
*/
#include <Elementary.h>
G_DEFINE_TYPE(EailSeparator, eail_separator, EAIL_TYPE_WIDGET);
/**
- * @brief Gets state set reference of the accessible.
+ * @brief Gets the state set of the accessible
*
* The caller must unreference it when it is no longer needed.
*
- * @param accessible an AtkObject instance
- * @return accessible state set
+ * @param accessible AtkObject instance
+ * @return AtkStateSet representing the state set of the accessible
*/
static AtkStateSet*
eail_separator_ref_state_set(AtkObject *accessible)
}
/**
- * @brief EailSeparator initializer.
+ * @brief EailSeparator initializer
*
- * @param obj an AtkObject instance
- * @param data initialize data
+ * @param obj AtkObject instance
+ * @param data initialization data
*/
static void
eail_separator_initialize(AtkObject *obj, gpointer data)
}
/**
- * @brief EailSeparator interface initializer.
+ * @brief EailSeparator interface initializer
*
* @param separator EailSeparator instance
*/
}
/**
- * @brief EailSeparator class initializer.
+ * @brief EailSeparator class initializer
*
- * @param klass EailSeparator class
+ * @param klass EailSeparatorClass instance
*/
static void
eail_separator_class_init(EailSeparatorClass *klass)
* @brief Macro upcasts an instance (obj) of a subclass to the EailSeparator
* type
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_SEPARATOR(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), \
EAIL_TYPE_SEPARATOR, EailSeparator))
/**
* @brief Tests whether object (obj) is an instance of EailSeparator class
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_IS_SEPARATOR(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), \
EAIL_TYPE_SEPARATOR))
/** @brief Definition of object structure for Atk EailActionSlider*/
struct _EailSeparator
{
- /** @brief Parent object that functionality is being extended*/
+ /** @brief Parent widget whose functionality is being extended*/
EailWidget parent;
};
/**
* @brief Initialization of AtkValue interface
*
- * @param iface EailSlider object
+ * @param iface AtkValueIface instance
*/
static void atk_value_interface_init(AtkValueIface *iface);
atk_value_interface_init));
/**
- * @brief handler for changed event
+ * @brief Handler for changed event
*
* @param data passed to callback
- * @param obj object that raised event
+ * @param obj Evas_Object that raised event
* @param event_info additional event info
*/
void
/**
* @brief EailSlider object initialization
*
- * @param obj EailSlider object
+ * @param obj AtkObject instance
* @param data user set additional initialization data
*/
static void
}
/**
- * @brief Gets list of children widgets
+ * @brief Gets the list of child widgets
*
- * @param widget EailWidget object
+ * @param widget EailWidget instance
*
- * @return list of children, NULL otherwise
+ * @return Eina_List representing the list of widget's children
*/
static Eina_List *
eail_slider_get_widget_children(EailWidget *widget)
}
/**
- * @brief Gets slider name
+ * @brief Gets the name of the slider
*
- * @param obj EailSlider instance
+ * @param obj AtkObject instance
*
- * @returns string representing slider name
+ * @returns string representing the name of the slider
*/
static const gchar*
eail_slider_get_name(AtkObject *obj)
/**
* @brief GObject type initialization function
*
- * @param klass EailSlider class
+ * @param klass EailSliderClass instance
*/
static void
eail_slider_class_init(EailSliderClass *klass)
*/
/**
- * @brief Gets obj current value
+ * @brief Gets the current value of obj
*
- * @param obj EailSlider instance
- * @param [out] value EailSlider current value
+ * @param obj AtkValue instance
+ * @param [out] value obj's current value
*/
static void
eail_slider_get_current_value(AtkValue *obj,
}
/**
- * @brief Gets obj maxiumum value
+ * @brief Gets the maxiumum value of obj
*
- * @param obj EailSlider instance
- * @param [out] value EailSlider maxiumum value
+ * @param obj AtkValue instance
+ * @param [out] value obj's maxiumum value
*/
static void
eail_slider_get_maximum_value(AtkValue *obj,
}
/**
- * @brief Gets obj minimum value
+ * @brief Gets the minimum value of obj
*
- * @param obj EailSlider instance
- * @param [out] value EailSlider minimum value
+ * @param obj AtkValue instance
+ * @param [out] value obj's minimum value
*/
static void
eail_slider_get_minimum_value(AtkValue *obj,
}
/**
- * @brief Sets obj value
+ * @brief Sets the value of obj
*
- * @param obj EailSlider instance
- * @param value EailSlider new value
- * @return TRUE if new value is set successfully, FALSE otherwise
+ * @param obj AtkValue instance
+ * @param value obj's new value
+ * @return TRUE if new value was set successfully, FALSE otherwise
*/
static gboolean
eail_slider_set_current_value(AtkValue *obj,
}
/**
- * @brief Gets obj minimum increment
+ * @brief Gets the minimum increment of obj
*
- * @param obj EailSlider instance
- * @param [out] value EailSlider minimum increment
+ * @param obj AtkValue instance
+ * @param [out] value obj's minimum increment
*/
static void
eail_slider_get_minimum_increment(AtkValue *obj,
g_value_set_double(value, 0);
}
+/**
+ * @brief AtkValue interface initializer
+ *
+ * @param iface AtkValueIface instance
+ */
static void
atk_value_interface_init(AtkValueIface *iface)
{
* @brief Macro upcasts an instance (obj) of a subclass to the EailSlider
* type
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_SLIDER(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), \
EAIL_TYPE_SLIDER, EailSlider))
/**
* @brief Tests whether object (obj) is an instance of EailSlider class
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_IS_SLIDER(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), \
EAIL_TYPE_SLIDER))
/** @brief Definition of object structure for Atk EailSlider*/
struct _EailSlider
{
- /** @brief Parent object that functionality is being extended*/
+ /** @brief Parent widget whose functionality is being extended*/
EailWidget parent;
};
atk_action_interface_init));
/**
- * @brief Implementation of ref_child from AtkObject interface
+ * @brief Gets a reference to the specified accessible child of the object.
*
- * @param obj EailSlideshow instance
+ * The accessible children are 0-based so the first accessible child
+ * is at index 0, the second at index 1 and so on.
+ *
+ * Implementation of ref_child from AtkObject interface.
+ *
+ * @param obj AtkObject instance
* @param i index of a child object
*
- * @returns child object
+ * @returns AtkObject representing the specified accessible child
*/
static AtkObject*
eail_slideshow_ref_child(AtkObject *obj, gint i)
}
/**
- * @brief Implementation of get_n_children from AtkObject interface
+ * @brief Gets the number of accessible children of the accessible
*
- * @param obj EailSlideshow instance
- * @returns number of widget childs
+ * Implementation of get_n_children from AtkObject interface.
+ *
+ * @param obj AtkObject instance
+ * @returns integer representing the number of widget's children
*/
static gint
eail_slideshow_n_children_get(AtkObject *obj)
}
/**
- * @brief Initialize EailSlideshow as a AtkObject
+ * @brief Initialize EailSlideshow as AtkObject
*
- * @param obj EailSlideshow instance
+ * @param obj AtkObject instance
* @param data user data passed to initialization
*/
static void
/**
* @brief Destructor of EailSlideshow object
*
- * @param object EailSlideshow instance
+ * @param object GObject instance
*/
static void
eail_slideshow_finalize(GObject *object)
/**
* @brief EailSlideshow class initialization
*
- * @param klass EailSlideshowClass object
+ * @param klass EailSlideshowClass instance
*/
static void
eail_slideshow_class_init(EailSlideshowClass *klass)
}
/**
- * @brief Implementation of selection_count from AtkSelection interface
+ * @brief Gets the number of accessible children currently selected.
+ *
+ * Implementation of get_selection_count from AtkSelection interface.
*
- * @param selection EailSlideshow instance
+ * @param selection AtkSelection instance
*
- * @returns number of actions
+ * @returns integer representing the number of currently selected children
*/
static gint
eail_slideshow_selection_count(AtkSelection *selection)
}
/**
- * @brief Implementation of add_selection from AtkSelection interface
+ * @brief Adds the specified accessible child of the object to the object's selection
*
- * @param selection EailSlideshow instance
+ * Implementation of add_selection from AtkSelection interface.
+ *
+ * @param selection AtkSelection instance
* @param i index of object to select
*
- * @returns TRUE on success FALSE otherwise
+ * @returns TRUE on success, FALSE otherwise
*/
static gboolean
eail_slideshow_add_selection(AtkSelection *selection, gint i)
}
/**
- * @brief Implementation ref_selecton from AtkSelection
+ * @brief Gets a reference to the accessible object representing
+ * the specified selected child of the object.
*
- * @param selection EailSlideshow instance
+ * Implementation of ref_selecton from AtkSelection.
+ *
+ * @param selection AtkSelection instance
* @param i index of selection
*
- * @returns selected AtkObject
+ * @returns AtkObject representing the specified selected child
*/
static AtkObject*
eail_slideshow_ref_selection(AtkSelection *selection, gint i)
}
/**
- * @brief Implementation of is_child_selected from AtkSelection
+ * @brief Determines if the current child of this object is selected.
+ *
+ * Implementation of is_child_selected from AtkSelection.
*
- * @param selection EailSlideshow instace
+ * @param selection AtkSelection instance
* @param i index of selection
*
- * @return TRUE if object is selected FALSE otherwise
+ * @return TRUE if object is selected, FALSE otherwise
*/
static gboolean
eail_slideshow_is_child_selected(AtkSelection *selection, gint i)
* implementation i.e hooks method pointers in the interface structure
* to the implementing class's implementation.
*
- * @param iface an AtkObject than implements AtkSelectionInterface
+ * @param iface AtkObject instance that implements AtkSelectionInterface
*/
static void atk_selection_interface_init(AtkSelectionIface *iface)
{
}
/**
- * @brief Implementation of get_n_action from AtkAction interface
+ * @brief Gets the number of accessible actions available on the object
*
- * @param action EailSlideshow instance
- * @returns number of implemented actions
+ * If there are more than one, the first one is considered the "default" action of the object.
+ *
+ * Implementation of get_n_actions from AtkAction interface.
+ *
+ * @param action AtkAction instance
+ * @returns integer representing the number of implemented actions
*/
static gint
eail_slideshow_n_actions_get(AtkAction *action)
}
/**
- * @brief Implementation of get_action_name from AtkAction interface
+ * @brief Gets the name of the specified action of the object
*
- * @param action EailSlideshow instance
+ * Implementation of get_name from AtkAction interface.
+ *
+ * @param action AtkAction instance
* @param i action index
*
- * @returns acton name
+ * @returns string representing the name of the specified action
*/
static const gchar*
eail_slideshow_action_name_get(AtkAction *action, int i)
/**
* @brief Compares two doubles
+ *
* @param A first number
* @param B second number
* @param max_ulps number of doubles between A and B
- * @returns TRUE if A == B, FALSE otherwise
+ * @returns TRUE if A equals B, FALSE otherwise
*/
static gboolean
_double_cmp(double A, double B, gint max_ulps)
}
/**
- * @brief Implementation of do action from AtkAction interface
+ * @brief Performs the specified action on the object
*
- * @param action EailSlideshow instance
+ * Implementation of do_action from AtkAction interface.
+ *
+ * @param action AtkAction instance
* @param i action index
*
* @returns TRUE on success, FALSE otherwise
}
/**
- * @brief Implementation of get_description from AtkAction interface
+ * @brief Gets the description of the specified action of the object
+ *
+ * Implementation of get_description from AtkAction interface.
*
- * @param action EailSlideshow instance
+ * @param action AtkAction instance
* @param i action index
*
- * @returns action description
+ * @returns string representing the description of the specified action
*/
static const gchar *
eail_slidshow_description_get(AtkAction *action, gint i)
}
/**
- * @brief Implementation of set_description from AtkAction interface
+ * @brief Sets a description of the specified action of the object
+ *
+ * Implementation of set_description from AtkAction interface.
*
- * @param action EailSlideshow instance
+ * @param action AtkAction instance
* @param i action index
- * @param description action description to set
+ * @param description action's description to set
*
* @returns TRUE on success, FALSE otherwise
*/
/**
* @brief AtkAction interface initialization
*
- * @param iface EailSlideshow object
+ * @param iface AtkActionIface instance
*/
static void
atk_action_interface_init(AtkActionIface *iface)
* @brief Macro upcasts an instance (obj) of a subclass to the EailSlideshow
* type
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_SLIDESHOW(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), \
EAIL_TYPE_SLIDESHOW, EailSlideshow))
/**
* @brief Tests whether object (obj) is an instance of EailSlideshow class
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_IS_SLIDESHOW(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), \
EAIL_TYPE_SLIDESHOW))
/** @brief Definition of object structure for Atk EailSlideshow*/
struct _EailSlideshow
{
- /** @brief Parent object that functionality is being extended*/
+ /** @brief Parent widget whose functionality is being extended*/
EailWidget parent;
- gchar *next_description;/*!< @brief 'next' action description*/
- gchar *previous_description;/*!< @brief 'previous' action description*/
- gchar *stop_description;/*!< @brief 'stop' action description*/
- gchar *start_description;/*!< @brief 'start' action description*/
+ gchar *next_description;/*!< @brief "next" action description*/
+ gchar *previous_description;/*!< @brief "previous" action description*/
+ gchar *stop_description;/*!< @brief "stop" action description*/
+ gchar *start_description;/*!< @brief "start" action description*/
};
/** @brief Definition of object class for Atk EailSlideshow*/
atk_value_interface_init));
/**
- * @brief EailSpinner interface initializer.
+ * @brief EailSpinner interface initializer
*
* @param spinner EailSpinner instance
*/
}
/**
- * @brief EailSpinner initializer.
+ * @brief EailSpinner initializer
*
- * @param obj an AtkObject instance
+ * @param obj AtkObject instance
* @param data initialization data
*/
void
}
/**
- * @brief Gets accessible name of accessible.
+ * @brief Gets the accessible name of the accessible
*
- * @param accessible an AtkObject instance
- * @return accessible name
+ * @param accessible AtkObject instance
+ * @return string representing the accessible name of the accessible
*/
const gchar*
eail_spinner_get_name(AtkObject *accessible)
}
/**
- * @brief EailSpinner class initializer.
+ * @brief EailSpinner class initializer
*
- * @param klass EailSpinner class
+ * @param klass EailSpinnerClass instance
*/
static void
eail_spinner_class_init(EailSpinnerClass *klass)
}
/**
- * @brief Gets obj current value.
+ * @brief Gets the current value of obj
*
- * @param obj an AtkValue instance
- * @param [out] value obj current value
+ * @param obj AtkValue instance
+ * @param [out] value obj's current value
*/
static void
eail_spinner_get_current_value(AtkValue *obj,
}
/**
- * @brief Gets obj maxiumum value.
+ * @brief Gets the maximum value of obj
*
- * @param obj an AtkValue instance
- * @param [out] value obj maxiumum value
+ * @param obj AtkValue instance
+ * @param [out] value obj's maxiumum value
*/
static void
eail_spinner_get_maximum_value(AtkValue *obj,
}
/**
- * @brief Gets obj minimum value.
+ * @brief Gets the minimum value of obj
*
- * @param obj an AtkValue instance
- * @param [out] value obj minimum value
+ * @param obj AtkValue instance
+ * @param [out] value obj's minimum value
*/
static void
eail_spinner_get_minimum_value(AtkValue *obj,
}
/**
- * @brief Sets obj value.
+ * @brief Sets the current value of obj
*
- * @param obj an AtkValue instance
- * @param value obj new value
- * @return TRUE if new value is set successfully, FALSE otherwise
+ * @param obj AtkValue instance
+ * @param value obj's new value
+ * @return TRUE if new value was set successfully, FALSE otherwise
*/
static gboolean
eail_spinner_set_current_value(AtkValue *obj,
}
/**
- * @brief Gets obj minimum increment.
+ * @brief Gets the minimum increment of obj
*
- * @param obj an AtkValue instance
- * @param [out] value obj minimum increment
+ * @param obj AtkValue instance
+ * @param [out] value obj's minimum increment
*/
static void
eail_spinner_get_minimum_increment(AtkValue *obj,
}
/**
- * @brief AtkValue interface initializer.
+ * @brief AtkValue interface initializer
*
- * @param iface an AtkValueIface instance
+ * @param iface AtkValueIface instance
*/
static void
atk_value_interface_init(AtkValueIface *iface)
* @brief Macro upcasts an instance (obj) of a subclass to the EailSpinner
* type
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_SPINNER(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), \
EAIL_TYPE_SPINNER, EailSpinner))
/**
* @brief Tests whether object (obj) is an instance of EailSpinner class
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_IS_SPINNER(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), \
EAIL_TYPE_SPINNER))
/** @brief Definition of object structure for Atk EailSpinner*/
struct _EailSpinner
{
- /** @brief Parent object that functionality is being extended*/
+ /** @brief Parent widget whose functionality is being extended*/
EailWidget parent;
};
/**
* @file eail_table.c
- * @brief Implementation of elm_table as AtkObject
+ * @brief EailTable implementation
*/
#include <Elementary.h>
#include "eail_table.h"
/**
- * @brief Smart type used by elm_table to get internal content of widget
+ * @brief Smart type used by elm_table to get internal content of the widget
*/
#define TABLE_SMART_TYPE "Evas_Object_Table"
G_DEFINE_TYPE(EailTable, eail_table, EAIL_TYPE_WIDGET);
/**
- * @brief EailTable initialize
+ * @brief Initialize EailTable
*
* Initialization of parent object, role etc.
*
- * @param object EailTable instance
+ * @param object AtkObject instance
* @param data user data passed to initialize
*/
static void
}
/**
- * @brief EailTable init
+ * @brief EailTable initialization
*
* @param table EailTable instance
*/
}
/**
- * @brief Implementation of get_widget_children from EailWidget
+ * @brief Gets a list of accessible children of widget
+ *
+ * Implementation of get_widget_children from EailWidget.
*
* @param widget EailTable instance
*
- * @returns list of widgets
+ * @returns Eina_List representing the list of widget's children
*/
static Eina_List *
eail_table_children_get(EailWidget *widget)
}
/**
- * @brief EailTable class initialize
+ * @brief EailTable class initialization
*
- * @param klass EailTable class
+ * @param klass EailTableClass instance
*/
static void
eail_table_class_init(EailTableClass *klass)
* @brief Macro upcasts an instance (obj) of a subclass to the EailTable
* type
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_TABLE(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), \
EAIL_TYPE_TABLE, EailTable))
/**
* @brief Tests whether object (obj) is an instance of EailTable class
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_IS_TABLE(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), \
EAIL_TYPE_TABLE))
/** @brief Definition of object structure for Atk EailTable*/
struct _EailTable
{
- /** @brief Parent object that functionality is being extended*/
+ /** @brief Parent widget whose functionality is being extended*/
EailWidget parent;
};
/**
* @brief EailText initializer
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
* @param data initialization data
*/
static void
}
/**
- * @brief Gets obj name
+ * @brief Gets the accessible name of obj
*
* Returns obj accessible name if assigned, obj text content otherwise
*
- * @param obj an AtkObject
- * @returns accessible obj name if assigned, obj text content otherwise
+ * @param obj AtkObject instance
+ * @returns string representing the accessible name of obj if assigned,
+ * obj text content otherwise
*/
static const gchar*
eail_text_get_name(AtkObject *obj)
/**
* @brief EailText instance initializer
*
- * @param text an EailText
+ * @param text EailText instance
*/
static void
eail_text_init(EailText *text)
/**
* @brief EailText class initializer
*
- * @param klass an EailTextClass
+ * @param klass EailTextClass instance
*/
static void
eail_text_class_init(EailTextClass *klass)
*
* Use g_free() to free the returned string
*
- * @param text an AtkText
+ * @param text AtkText instance
* @param start_offset start position
* @param end_offset end position, -1 for the end of the string
* @return string containing text from start_offset up to, but not including
}
/**
- * @brief Gets character at offset
+ * @brief Gets the character at offset
*
- * @param text an AtkText
+ * @param text AtkText instance
* @param offset character offset
- * @return character at offset
+ * @return char representing the character at offset
*/
static gunichar
eail_text_get_character_at_offset(AtkText *text,
}
/**
- * @brief Gets text length
+ * @brief Gets the text's length
*
- * @param text an AtkText
- * @return text length
+ * @param text AtkText instance
+ * @return integer representing the text length
*/
static gint
eail_text_get_character_count(AtkText *text)
/**
* @brief AtkText interface initializer
*
- * @param iface an AtkTextIface
+ * @param iface AtkTextIface instance
*/
static void
atk_text_interface_init(AtkTextIface *iface)
* @brief Macro upcasts an instance (obj) of a subclass to the EailText
* type
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_TEXT(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), \
EAIL_TYPE_TEXT, EailText))
/**
* @brief Tests whether object (obj) is an instance of EailText class
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_IS_TEXT(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), \
EAIL_TYPE_TEXT))
/** @brief Definition of object structure for Atk EailActionSlider*/
struct _EailText
{
- /** @brief Parent object that functionality is being extended*/
+ /** @brief Parent widget whose functionality is being extended*/
EailWidget parent;
};
/**
* @brief EailThumb initializer
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
* @param data initialization data
*/
static void
/**
* @brief EailThumb instance initializer
*
- * @param thumb an EailThumb
+ * @param thumb EailThumb instance
*/
static void
eail_thumb_init(EailThumb *thumb)
}
/**
- * @brief Gets obj state set
+ * @brief Gets the state set of obj
*
- * @param obj an AtkObject
- * @return obj state set
+ * @param obj AtkObject instance
+ * @return AtkStateSet representing the state set of obj
*/
static AtkStateSet*
eail_thumb_ref_state_set(AtkObject *obj)
/**
* @brief EailThumb class initializer
*
- * @param klass an EailThumbClass
+ * @param klass EailThumbClass instance
*/
static void
eail_thumb_class_init(EailThumbClass *klass)
}
/**
- * @brief Gets thumb current size
+ * @brief Gets the current size of a thumb
*
- * @param image an AtkImage
- * @param [out] width thumb current width
- * @param [out] height thumb current height
+ * @param image AtkImage instance
+ * @param [out] width thumb's current width
+ * @param [out] height thumb's current height
*/
static void
eail_thumb_size_get(AtkImage *image, gint *width, gint *height)
/**
* @brief AtkImage interface initializer
*
- * @param iface an AtkImageIface
+ * @param iface AtkImageIface instance
*/
static void
atk_image_iface_init(AtkImageIface *iface)
* @brief Macro upcasts an instance (obj) of a subclass to the EailThumb
* type
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_THUMB(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), \
EAIL_TYPE_THUMB, EailThumb))
/**
* @brief Tests whether object (obj) is an instance of EailThumb class
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_IS_THUMB(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), \
EAIL_TYPE_THUMB))
/** @brief Definition of object structure for Atk EailThumb*/
struct _EailThumb
{
- /** @brief Parent object that functionality is being extended*/
+ /** @brief Parent widget whose functionality is being extended*/
EailImage parent;
};
/**
* @file eail_toolbar.c
- * @brief Implementation of toolbar widget
+ * @brief EailToolbar implementation
*/
#include <atk/atk.h>
* @brief Implementation of the *AtkObject* interface
*
* Basic initialization for AtkObject (parent initialization, role definition
- * etc.)
+ * etc.).
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
* @param data additional data passed to initialization
*/
static void
/**
* @brief EailToolbar instance initializer
*
- * @param toolbar an EailToolbar
+ * @param toolbar EailToolbar instance
*/
static void
eail_toolbar_init(EailToolbar *toolbar)
/**
* @brief Gets toolbar items
*
- * @param toolbar an EailToolbar
- * @return list of Elm_Object_Item* objects
+ * @param toolbar EailToolbar instance
+ * @return Eina_List representing the list of Elm_Object_Item objects
* */
static Eina_List *
eail_toolbar_get_items(EailToolbar *toolbar)
}
/**
- * @brief Implementation AtkObject->get_n_children callback
+ * @brief Gets the number of accessible children of the accessible
*
- * ATK doc says:\n
- * Gets the number of accessible children of the accessible.
- * @param obj an AtkObject
+ * Implementation of AtkObject->get_n_children callback.
*
- * @returns an integer representing the number of accessible children of
+ * @param obj AtkObject instance
+ *
+ * @returns integer representing the number of accessible children of
* the accessible
*/
static gint
}
/**
- * @brief Implementation AtkObject->ref_child callback
+ * @brief Gets a reference to the specified accessible child of the object.
*
- * ATK doc says:\n
- * Gets a reference to the specified accessible child of the object. The
- * accessible children are 0-based so the first accessible child is at index 0,
+ * The accessible children are 0-based so the first accessible child is at index 0,
* the second at index 1 and so on.
*
- * @param obj an AtkObject
+ * Implementation of AtkObject->ref_child callback.
+ *
+ * @param obj AtkObject instance
* @param i index of a child
*
- * @returns an AtkObject representing the specified accessible child of the
- * accessible.
+ * @returns AtkObject representing the specified accessible child of the
+ * accessible
*/
static AtkObject *
eail_toolbar_ref_child(AtkObject *obj, gint i)
}
/**
- * @brief Initializer for EailToolbar GObject class (defines callbacks for
- * base AtkObject)
+ * @brief Initializer for EailToolbar GObject class
*
- * @param klass an EailToolbar class
+ * Defines callbacks for base AtkObject.
+ *
+ * @param klass EailToolbarClass instance
*/
static void
eail_toolbar_class_init(EailToolbarClass *klass)
/**
* @brief Gets the object of item
*
- * @param parent an EailItemParent
- * @param item an EailItem
- * @returns item object
+ * @param parent EailItemParent instance
+ * @param item EailItem instance
+ * @returns Evas_Object representing the item
*/
static Evas_Object *
eail_toolbar_get_evas_obj(EailItemParent *parent,
}
/**
- * @brief Implementation of EailItemParent->get_actions_supported callback
+ * @brief Gets supported actions
+ *
+ * Implementation of EailItemParent->get_actions_supported callback.
*
- * @param parent an EailItemParent
- * @param item an EailItem
- * @returns enum representing supported actions
+ * @param parent EailItemParent instance
+ * @param item EailItem instance
+ * @returns integer representing supported actions
*/
static gint
eail_toolbar_get_actions_supported(EailItemParent *parent,
}
/**
- * @brief Gets item accessible name
+ * @brief Gets the accessible name of the item
*
- * @param parent an EailItemParent
- * @param item an EailItem
+ * @param parent EailItemParent instance
+ * @param item EailItem instance
*
- * @returns item accessible name
+ * @returns string representing the accessible name of the item
*/
static const gchar *
eail_toolbar_item_name_get(EailItemParent *parent, EailItem *item)
* interface implementation i.e hooks method pointers in the interface structure
* to the implementing class's implementation.
*
- * @param iface an EailItemParent interface
+ * @param iface EailItemParent interface
*/
static void
eail_item_parent_interface_init(EailItemParentIface *iface)
* @brief Macro upcasts an instance (obj) of a subclass to the EailToolbar
* type
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_TOOLBAR(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), \
EAIL_TYPE_TOOLBAR, \
/**
* @brief Tests whether object (obj) is an instance of EailToolbar class
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_IS_TOOLBAR(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), \
EAIL_TYPE_TOOLBAR))
/** @brief Definition of object structure for Atk EailToolbar*/
struct _EailToolbar
{
- /** @brief Parent object that functionality is being extended*/
+ /** @brief Parent widget whose functionality is being extended*/
EailWidget parent;
};
/**
* @file eail_utils.c
- * @brief Implementation of utility functions used in various places in EAIL
- * code
+ * @brief Implementation of Utility Functions
*/
/* enabling beta API support for Eo parts*/
}
/**
- * @param widget Evas_Object for getting state_set
- * @param state_set current state_set taken from objects parent
+ * @param widget Evas_Object instance for getting state set
+ * @param state_set current state set taken from object's parent
*
- * @returns filled AtkStateSet for given EvasObject
+ * @returns AtkStateSet representing the given Evas_Object
*/
AtkStateSet *
eail_evas_obj_ref_state_set(Evas_Object *widget, AtkStateSet *state_set)
}
/**
- * @param widget an Evas_Object
+ * @param widget Evas_Object instance
* @return TRUE if grabbing focus was successfull, FALSE otherwise
*/
gboolean
}
/**
- * @param widget an Evas_Object to press on
- * @param x X coord
- * @param y y coord
+ * @param widget Evas_Object instance to press on
+ * @param x x coordinate
+ * @param y y coordinate
*/
void
eail_mouse_press_on_coords(Evas_Object *widget, int x, int y)
}
/**
- * @param widget an Evas_Object to press on
- * @param x X coord
- * @param y y coord
+ * @param widget Evas_Object instance to press on
+ * @param x x coordinate
+ * @param y y coordinate
*/
void
eail_mouse_release_on_coords(Evas_Object *widget, int x, int y)
}
/**
- * @param widget an Evas_Object to click on
- * @param x X coord
- * @param y y coord
+ * @param widget Evas_Object instance to click on
+ * @param x x coordinate
+ * @param y y coordinate
*/
void
eail_mouse_click_on_coords(Evas_Object *widget, int x, int y)
}
/**
- * @param widget an Evas_Object to get values for
- * @param x address of int to put X coord in
- * @param y address of int to put Y coord in
+ * @param widget Evas_Object instance to get values for
+ * @param [out] x x coordinate
+ * @param [out] y Y coordinate
*/
void
eail_get_coords_widget_center(Evas_Object *widget, int *x, int *y)
}
/**
- * @param item an Elm_Object_Item*
+ * @param item Elm_Object_Item* instance
*
- * @returns Eina_List * filled with raw Evas_Object* (not every returned
- * Evas_Object is widget - widget-only content is returned by
- * eail_get_edje_parts_for_item function)
+ * @returns Eina_List * representing the list of raw Evas_Object*
+ * (not every returned Evas_Object is a widget - widget-only content
+ * is returned by eail_get_edje_parts_for_item function)
*/
Eina_List *
eail_get_raw_evas_obj_list_from_item(Elm_Object_Item *item)
}
/**
- * @param item Elm_Object_Item * to get strings from
- * @returns EinaList filled with const gchar* that are representing text
- * content of item. List have to be freed when no longer needed but DO NOT
+ *
+ * The returned list has to be freed when no longer needed but DO NOT
* FREE CONTENT STRINGS.
+ *
+ * @param item Elm_Object_Item * to get strings from
+ * @returns Eina_List representing the list of string that represent text
+ * content of item
*/
Eina_List *
eail_item_get_content_strings(Elm_Object_Item *item)
/**
* It does filtering inside and returs only parts that can be used later in
- * eail factory (only widgets will be returned)
+ * eail factory (only widgets will be returned).
*
- * @param item Elm_Object_Item * to get objects from
+ * @param item Elm_Object_Item instance to get objects from
*
- * @returns Eina_List* filled with Evas_Object* objects representing content
+ * @returns an Eina_List filled with Evas_Object* objects representing content
* found inside item
*/
Eina_List *
/**
*
- * @param widget am Evas_Object
+ * @param widget Evas_Object instance
* @param type type of scroll action
*
* @returns TRUE if scroll action was successful, FALSE otherwise
/**
*
- * @param widget an Evas_Object*
+ * @param widget Evas_Object* instance
* @param data additional action data
* @returns TRUE if scroll action was successful, FALSE otherwise
*/
/**
*
- * @param widget an Evas_Object*
+ * @param widget Evas_Object* instance
* @param data additional action data
*
* @returns TRUE if scroll action was successful, FALSE otherwise
/**
*
- * @param widget an Evas_Object*
+ * @param widget Evas_Object* instance
* @param data additional action data
*
* @returns TRUE if scroll action was successful, FALSE otherwise
/**
*
- * @param widget an Evas_Object*
+ * @param widget Evas_Object* instance
* @param data additional action data
*
* @returns TRUE if scroll action was successful, FALSE otherwise
}
/**
- * @param atk_obj an AtkObject that emits the signal
+ * @param atk_obj AtkObject instance that emits the signal
* @param signal_name name of signal
- * @param object_type an GType of object
+ * @param object_type GType of object
*/
void
eail_emit_atk_signal(AtkObject *atk_obj, const gchar *signal_name,
/**
* @param added boolean used for marking if child is added. TRUE if child was
* added, FALSE when child was removed
- * @param atk_obj an AtkObject that emits the signal
+ * @param atk_obj AtkObject instance that emits the signal
* @param child_number index number of changed child
*/
void
}
/**
- * @brief handles 'selected' state changes for item
+ * @brief Handles 'selected' state changes for item
*
- * @param item an Elm_Object* item
+ * @param item Elm_Object instance
* @param selected value of 'selected' state
- * @param parent an AtkObject* that holds item inside
- * @param role an AtkRole for item
+ * @param parent AtkObject that holds item inside
+ * @param role role of item
*/
static void
_eail_handle_selected_for_item(Elm_Object_Item *item,
* @brief Function that calls apropriate handling for selected event
*
* @param data passed to callback
- * @param obj object that raised event
+ * @param obj Evas_Object that raised event
* @param event_info additional event info
* @param selected selected state
*/
/**
*
* @param data passed to callback
- * @param obj object that raised event
+ * @param obj Evas_Object that raised event
* @param event_info additional event info
*/
void
/**
*
* @param data passed to callback
- * @param obj object that raised event
+ * @param obj Evas_Object that raised event
* @param event_info additional event info
*/
void
extern "C" {
#endif
-#define EAIL_STR_SCROLL_UP "scroll_up" /**< @brief String for scroll up*/
-#define EAIL_STR_SCROLL_DOWN "scroll_down" /**< @brief String for scroll down*/
-#define EAIL_STR_SCROLL_LEFT "scroll_left" /**< @brief String for scroll left*/
-#define EAIL_STR_SCROLL_RIGHT "scroll_right" /**< @brief String for scroll right*/
+#define EAIL_STR_SCROLL_UP "scroll_up" /**< @brief String for 'scroll up'*/
+#define EAIL_STR_SCROLL_DOWN "scroll_down" /**< @brief String for 'scroll down'*/
+#define EAIL_STR_SCROLL_LEFT "scroll_left" /**< @brief String for 'scroll left'*/
+#define EAIL_STR_SCROLL_RIGHT "scroll_right" /**< @brief String for 'scroll right'*/
/**
* @enum EAIL_SCROLL_TYPE Type of scroll direction
Eina_List *eail_item_get_content_strings(Elm_Object_Item *item);
/**
- * @brief scrolls screen to given direction
+ * @brief Scrolls screen to given direction
*/
gboolean eail_handle_scroll(Evas_Object *widget,
enum EAIL_SCROLL_TYPE type);
/**
- * @brief scrolls screen up
+ * @brief Scrolls screen up
*/
gboolean eail_action_scroll_up(Evas_Object *widget,
void *data);
/**
- * @brief scrolls screen down
+ * @brief Scrolls screen down
*/
gboolean eail_action_scroll_down(Evas_Object *widget,
void *data);
/**
- * @brief scrolls screen left
+ * @brief Scrolls screen left
*/
gboolean eail_action_scroll_left(Evas_Object *widget,
void *data);
/**
- * @brief scrolls screen right
+ * @brief Scrolls screen right
*/
gboolean eail_action_scroll_right(Evas_Object *widget,
void *data);
/**
- * @brief emits signal for ATK Object
+ * @brief Emits signal for ATK Object
*/
void eail_emit_atk_signal(AtkObject * atk_obj,
const gchar *signal_name,
GType object_type);
/**
- * @brief handler for selected event in for list-based content
+ * @brief Handler for selected event in for list-based content
*/
void eail_list_item_handle_selected_event(void *data,
Evas_Object *obj,
void *event_info);
/**
- * @brief handler for unselected event for list-based content
+ * @brief Handler for unselected event for list-based content
*/
void eail_list_item_handle_unselected_event(void *data,
Evas_Object *obj,
/**
- * @brief gets raw evas object list for eail item
+ * @brief Gets raw evas object list for eail item
*/
Eina_List *eail_get_raw_evas_obj_list_from_item(Elm_Object_Item *item);
/**
- * @brief Helper function for emit children changed signal when needed
+ * @brief Helper function for emitting 'children changed' signal when needed
*/
void eail_emit_children_changed(gboolean added,
AtkObject *atk_obj,
*/
/**
* @file eail_video.c
- * @brief Implementation of elm_video as AtkObject
+ * @brief EailVideo implementation
*/
#include <Elementary.h>
#include <Emotion.h>
static void atk_stremable_content_iface_init(AtkStreamableContentIface *iface);
/**
- * @brief define EailVideo type
+ * @brief Define EailVideo type
*/
G_DEFINE_TYPE_WITH_CODE(EailVideo, eail_video, EAIL_TYPE_WIDGET,
G_IMPLEMENT_INTERFACE(ATK_TYPE_ACTION,
);
/**
- * @brief Implementation of ref_state_set from AtkObject
+ * @brief Gets a reference to the state set of the accessible
*
- * @param object EailVideo instance
+ * The caller must unreference it when it is no longer needed.
+ *
+ * Implementation of ref_state_set from AtkObject.
+ *
+ * @param object AtkObject instance
*
- * @returns referred AtkStateSet object with accessible state set
+ * @returns AtkStateSet representing the state set of the accessible
*/
static AtkStateSet*
eail_video_ref_state_set(AtkObject *object)
}
/**
- * @brief Implementation of get_name from AtkObject
+ * @brief Gets the accessible name of the accessible
*
- * @param object EailVideo instance
+ * Implementation of get_name from AtkObject.
+ *
+ * @param object AtkObject instance
*
- * @returns played video file title or NULL if not set
+ * @returns string representing the title of played video file
+ * or NULL if name is not set
*/
static const gchar*
eail_video_name_get(AtkObject *object)
}
/**
- * @brief Initialize EailVideo object
+ * @brief Initializes EailVideo object
*
- * @param object EailVideo instance
+ * @param object AtkObject instance
* @param data passed user data
*/
static void
}
/**
- * @brief Init EailVideo object
+ * @brief Initiates EailVideo object
*
* @param video EailVideo instance
*/
}
/**
- * @brief Finalize EailVideo object
+ * @brief Finalizes EailVideo object
*
* @param object EailVideo instance
*/
}
/**
- * @brief Initialize EailVideo class
+ * @brief Initializes EailVideo class
*
- * @param klass EailVideoClass object
+ * @param klass EailVideoClass instance
*/
static void
eail_video_class_init(EailVideoClass *klass)
}
/**
- * @brief Implementation of get_action_name from AtkAction interface
+ * @brief Gets the name of the specified action of the object
+ *
+ * Implementation of get_action_name from AtkAction interface.
*
- * @param action EailVideo instance
+ * @param action AtkAction instance
* @param i action index
*
- * @returns action name
+ * @returns string representing the name of the specified action
*/
static const gchar*
eail_video_action_name_get(AtkAction *action, gint i)
}
/**
- * @brief Implementation of get_n_actions from AtkAction interface
+ * @brief Gets the number of accessible actions available on the object
+ *
+ * If there are more than one, the first one is considered
+ * the "default" action of the object.
*
- * @param action EailVideo instance
+ * Implementation of get_n_actions from AtkAction interface.
*
- * @returns number of actions supported by EailVideo object
+ * @param action AtkAction instance
+ *
+ * @returns integer representing the number of actions
+ * supported by EailVideo object
*/
static gint
eail_video_n_actions_get(AtkAction *action)
}
/**
- * @brief Implementation of do_action from AtkAction interface
+ * @brief Performs the specified action on the object
+ *
+ * Implementation of do_action from AtkAction interface.
*
- * @param action EailVideo instance
+ * @param action AtkAction instance
* @param i action index
*
* @returns TRUE on success, FALSE otherwise
}
/**
- * @brief Implementation of get_description from AtkAction interface
+ * @brief Gets the description of the specified action of the object
*
- * @param action EailVideo instance
+ * Implementation of get_description from AtkAction interface.
+ *
+ * @param action AtkAction instance
* @param i action index
*
- * @returns action description
+ * @returns string representing the description of the specified action
*/
static const gchar*
eail_video_description_get(AtkAction *action, gint i)
}
/**
- * @brief Implementation of set_description from AtkAction interface
+ * @brief Sets a description of the specified action of the object
+ *
+ * Implementation of set_description from AtkAction interface.
*
- * @param action EailVideo instance
+ * @param action AtkAction instance
* @param i action index
* @param description action descritpion
*
}
/**
- * @brief AtkAction interface initializer.
+ * @brief AtkAction interface initializer
*
* Function called upon instance creation. It initializes AtkAction
* interface implementation i.e hooks method pointers in the interface structure
* to the implementing class's implementation.
*
- * @param iface an AtkActionIface
+ * @param iface AtkActionIface instance
*/
static void
atk_action_interface_init(AtkActionIface *iface)
}
/**
- * @brief Helper function for matching file extension with mime type
+ * @brief Helper function for matching file extension with a mime type
*
* @param ext file extension
*
- * @returns mime type
+ * @returns string representing the mime type
*/
static const char *
_match_mime_type(const char *ext)
}
/**
- * @brief Helper function for getting extension from filename
+ * @brief Helper function for getting extension from a filename
*
* @param filename target filename
*
- * @returns pointer to string with extension
+ * @returns string representing the file extension
*/
static const char *
_get_file_ext(const char *filename) {
}
/**
- * @brief Helper function for getting video file path
+ * @brief Helper function for getting the video's file path
*
- * @param widget elm_video instance
+ * @param widget Evas_Object instance
*
- * @returns path to video file
+ * @returns string representing the path to video file
*/
static const char *
_get_video_path(const Evas_Object *widget)
}
/**
- * @brief Implementation of get_mime_type from AtkStreamableContent interface
+ * @brief Gets the character string of the specified mime type
+ *
+ * The first mime type is at position 0, the second at position 1, and so on.
*
- * @param streamable EailVideo instance
+ * Implementation of get_mime_type from AtkStreamableContent interface.
+ *
+ * @param streamable AtkStreamableContent instance
* @param i index of supported mime type
*
- * @returns mime type
+ * @returns string representing the specified mime type
*/
static const gchar*
eail_video_mime_type_get(AtkStreamableContent *streamable, gint i)
}
/**
- * @brief Implementation of get_n_mime_types from AtkStreamableContent interface
+ * @brief Gets the number of mime types supported by this object
+ *
+ * For video widget implementation by ATK-EAIL, there will always be maximum one
+ * supported content type at a time for the given file,
+ * so this function will always return 1 or 0.
*
- * For Video widget implementation by ATK-EAIL, there always be maximum one
- * content type at time supported for given file.
- * So this function always will return 1 or 0.
+ * Implementation of get_n_mime_types from AtkStreamableContent interface.
*
- * @param streamable EailVideo instance
+ * @param streamable AtkStreamableContent instance
*
- * @returns number of mime_types for given streamable content ('0' in case when
- * no mime-type was matched for content file)
+ * @returns integer representing the number of mime-types for the given
+ * streamable content ('0' in case when no mime-type was matched for content file)
*/
static gint
eail_video_n_mime_types_get(AtkStreamableContent *streamable)
}
/**
- * @brief Implementation of get_uri from AtkStreamableContent
+ * @brief Gets a string representing an URI
*
- * @param streamable EailVideo instance
+ * Gets a string representing a URI in IETF standard format
+ * (see http://www.ietf.org/rfc/rfc2396.txt) from which the object's
+ * content may be streamed in the specified mime-type, if one is available.
+ * If mime_type is NULL, the URI for the default (and possibly only)
+ * mime-type is returned.
+ *
+ * Implementation of get_uri from AtkStreamableContent.
+ *
+ * @param streamable AtkStreamableContent instance
* @param mime_type requested mime type
*
- * @returns video file URI
+ * @returns string representing the video file's URI
*/
static const char *
eail_video_get_uri(AtkStreamableContent *streamable, const gchar *mime_type)
}
/**
- * @brief Implementation of get_stream from AtkStreamableContent
+ * @brief Gets the content in the specified mime type
*
- * @param streamable EailVideo instance
- * @param mime_type requested mime_type
+ * Implementation of get_stream from AtkStreamableContent.
+ *
+ * @param streamable AtkStreamableContent instance
+ * @param mime_type requested mime type
*
* @returns GIOChannel to video file
*/
}
/**
- * @brief Initialize AtkStreamableContent interface
+ * @brief Initializes AtkStreamableContent interface
*
- * @param iface EailVideo object
+ * @param iface EailVideo instance
*/
static void
atk_stremable_content_iface_init(AtkStreamableContentIface *iface)
/** @brief Definition of object structure for Atk EailVideo*/
struct _EailVideo
{
- EailWidget parent; /*!< EailVideo parent that functionality is being extended*/
- char *forward_desc; /*!< forward action description*/
- char *next_desc; /*!< next action descritpion*/
- char *pause_desc; /*!< pause action descirption*/
- char *play_desc; /*!< play action description*/
- char *prev_desc; /*!< prev action description*/
- char *rewind_desc; /*!< rewind action description*/
- char *stop_desc; /*!< stop action description*/
- char *uri; /*!< video file URI*/
+ /** @brief Parent widget whose functionality is being extended*/
+ EailWidget parent;
+ /** @brief 'forward' action description*/
+ char *forward_desc;
+ /** @brief 'next' action descritpion*/
+ char *next_desc;
+ /** @brief 'pause' action descirption*/
+ char *pause_desc;
+ /** @brief 'play' action description*/
+ char *play_desc;
+ /** @brief 'prev' action description*/
+ char *prev_desc;
+ /** @brief 'rewind' action description*/
+ char *rewind_desc;
+ /** @brief 'stop' action description*/
+ char *stop_desc;
+ /** @brief Video file URI*/
+ char *uri;
};
/** @brief Definition of object structure for Atk EailVideo*/
/**
* @file eail_web.c
- * @brief Implementation of web widget
+ * @brief EailWeb implementation
*/
#include <atk/atk.h>
/**
* @brief Initializer for AtkObject
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
* @param data initializer data
*/
static void
/**
* @brief EailWeb instance initializer
*
- * @param web an EailWeb
+ * @param web EailWeb instance
*/
static void
eail_web_init(EailWeb *web)
}
/**
- * @brief Implementation AtkObject->get_n_children callback
+ * @brief Gets the number of accessible children of the accessible
*
- * ATK doc says:\n
- * Gets the number of accessible children of the accessible.
- * @param obj an AtkObject
+ * Implementation of AtkObject->get_n_children callback.
*
- * @returns an integer representing the number of accessible children of
+ * @param obj AtkObject instance
+ *
+ * @returns integer representing the number of accessible children of
* the accessible
*/
static gint
}
/**
- * @brief Implementation AtkObject->ref_child callback
+ * @brief Gets a reference to the specified accessible child of the object.
*
- * ATK doc says:\n
- * Gets a reference to the specified accessible child of the object. The
- * accessible children are 0-based so the first accessible child is at index 0,
+ * The accessible children are 0-based so the first accessible child is at index 0,
* the second at index 1 and so on.
*
- * @param obj an AtkObject
+ * Implementation of AtkObject->ref_child callback
+ *
+ * @param obj AtkObject instance
* @param i index of a child
*
- * @returns an AtkObject representing the specified accessible child of the
- * accessible.
+ * @returns AtkObject representing the specified accessible child of the
+ * accessible
*/
static AtkObject *
eail_web_ref_child(AtkObject *obj, gint i)
/**
* @brief Destructor of EailWeb object
- * @param object a GObject
+ *
+ * @param object GObject instance
*/
static void
eail_web_finalize(GObject *object)
}
/**
- * @brief Implementation of get_name from AtkObject
+ * @brief Gets the accessible name of the accessible
*
- * @param object EailWeb instance
- * @returns first name from the following list which is not null:
+ * Implementation of get_name from AtkObject.
+ *
+ * @param object AtkObject instance
+ * @returns a string representing the first attribute from the
+ * following list which is not null:
* accessible name, uri, title, or NULL if all strings were NULL
*/
static const gchar*
}
/**
- * @brief Initializer for EailWeb GObject class (defines callbacks for
- * base AtkObject)
+ * @brief Initializer for EailWeb GObject class
+ *
+ * Defines callbacks for base AtkObject.
*
- * @param klass an EailWebClass
+ * @param klass EailWebClass instance
*/
static void
eail_web_class_init(EailWebClass *klass)
* @brief Macro upcasts an instance (obj) of a subclass to the EailWeb
* type
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_WEB(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), \
EAIL_TYPE_WEB, \
/**
* @brief Tests whether object (obj) is an instance of EailWeb class
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_IS_WEB(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), \
EAIL_TYPE_WEB))
/** @brief Definition of object structure for Atk EailWeb*/
struct _EailWeb
{
- EailWidget parent;/**< @brief object that functionality is being extended*/
+ EailWidget parent;/**< @brief Parent widget whose functionality is being extended*/
};
/** @brief Definition of object class for Atk EailWeb*/
atk_component_interface_init));
/**
- * @brief Gets EvasObject from EailWidget
+ * @brief Gets Evas_Object from EailWidget
*
- * @param widget an EailWidget
- * @return Evas_Object widget
+ * @param widget EailWidget instance
+ * @return Evas_Object widget representing the EailWidget
*/
Evas_Object *
eail_widget_get_widget(EailWidget *widget)
}
/**
- * @brief Gets EailWidget children
+ * @brief Gets EailWidget's children
*
- * @param widget an EailWidget
- * @return children list
+ * @param widget EailWidget instance
+ * @return Eina_List representing the EailWidget's children list
*/
Eina_List *
eail_widget_get_widget_children(EailWidget *widget)
}
/**
- * @brief Callback used to tracking focus-in changes for widgets
+ * @brief Callback used for tracking focus-in changes for widgets
*
* @param data data passed to callback
- * @param e an Evas that has been focused in
- * @param obj an Evas_Object that has been focused in
+ * @param e Evas instance that has been focused in
+ * @param obj Evas_Object instance that has been focused in
* @param event_info additional event info
*/
void
}
/**
- * @brief Callback used to tracking "show"-changes for widgets
+ * @brief Callback used for tracking show-changes for widgets
*
* @param data data passed to callback
- * @param e an Evas that has been shown
- * @param obj an Evas_Object that has been shown
+ * @param e Evas instance that has been shown
+ * @param obj Evas_Object instance that has been shown
* @param event_info additional event info
*/
void
}
/**
- * @brief Callback used to tracking "hide"-changes for widgets
+ * @brief Callback used for tracking hide-changes for widgets
*
* @param data data passed to callback
- * @param e an Evas that has been shown
- * @param obj an Evas_Object that has been shown
+ * @param e Evas instance that has been shown
+ * @param obj Evas_Object instance that has been shown
* @param event_info additional event info
*/
void
}
/**
- * @brief Callback used to tracking focus-out changes for widgets
+ * @brief Callback used for tracking focus-out changes for widgets
*
* @param data data passed to callback
- * @param e an Evas that has been focused out
- * @param obj an Evas_Object that has been focused out
+ * @param e Evas instance that has been focused out
+ * @param obj Evas_Object instance that has been focused out
* @param event_info additional event info
*/
void
}
/**
- * @brief on_focused default callback used to tracking focus changes of
+ * @brief Default callback for on_focused used for tracking focus changes of
* smart widgets
*
* @param data data passed to callback
- * @param obj an Evas_Object that has been shown
+ * @param obj Evas_Object instance that has been shown
* @param event_info additional event info
*/
void eail_widget_on_focused_smart(void *data,
/**
* @brief EailWidget initializer
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
* @param data initialization data
*/
static void
/**
* @brief Default get_widget_children callback
*
- * @param widget an EailWidget
+ * @param widget EailWidget instance
* @return NULL
*/
static Eina_List *
}
/**
- * @brief Gets obj children count
+ * @brief Gets the number of children of obj
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*
- * @returns number of widget children
+ * @returns integer representing the number of widget's children
*/
static gint
eail_widget_get_n_children(AtkObject *obj)
}
/**
- * @brief Gets reference to obj i-th child
+ * @brief Gets reference to specified child of obj
*
- * The caller must unreference it when it is no longer needed
+ * The caller must unreference it when it is no longer needed.
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
* @param i child index
- * @return child reference
+ * @return AtkObject representing the specified child of obj
*/
static AtkObject *
eail_widget_ref_child(AtkObject *obj, gint i)
}
/**
- * @brief Gets obj parent
+ * @brief Gets the parent of obj
*
- * @param obj an AtkObject
- * @return obj parent
+ * @param obj AtkObject instance
+ * @return AtkObject representing the parent of obj
*/
static AtkObject *
eail_widget_get_parent(AtkObject *obj)
/**
* @brief Gets the 0-based index of this accessible in its parent
*
- * Returns -1 if the accessible does not have an accessible parent
+ * Returns -1 if the accessible does not have an accessible parent.
*
- * @param obj an AtkObject
- * @return obj index in its parent
+ * @param obj AtkObject instance
+ * @return integer representing obj's index in its parent
*/
static gint
eail_widget_get_index_in_parent(AtkObject *obj)
}
/**
- * @brief Gets obj state set
+ * @brief Gets the state set of obj
*
- * @param obj an AtkObject
- * @return obj state set
+ * @param obj AtkObject instance
+ * @return AtkState representing the state set of obj
*/
static AtkStateSet *
eail_widget_ref_state_set(AtkObject *obj)
}
/**
- * @brief Gets obj attribute set
+ * @brief Gets the attribute set of obj
*
- * @param obj an AtkObject
- * @return obj attribute set
+ * @param obj AtkObject instance
+ * @return AtkAttributeSet representing obj's attribute set
*/
static AtkAttributeSet *
eail_widget_get_attributes(AtkObject *obj)
/**
* @brief EailWidget instance initializer
*
- * @param widget an EailWidget
+ * @param widget EailWidget instance
*/
static void
eail_widget_init(EailWidget *widget)
/**
* @brief EailWidget finalizer
*
- * Frees memory assigned to object
+ * Frees memory assigned to object.
*
- * @param obj a GObject
+ * @param obj GObject instance
*/
static void
eail_widget_class_finalize(GObject *obj)
* Function called upon instance creation. It initializes AtkObject class
* callbacks for EailWidget.
*
- * @param klass an EailWidgetClass
+ * @param klass EailWidgetClass instance
*/
static void
eail_widget_class_init(EailWidgetClass *klass)
}
/**
- * @brief Grabs focus for component
+ * @brief Grabs focus of a component
*
- * @param component an AtkComponent
+ * @param component AtkComponent instance
* @return TRUE on success, FALSE otherwise
*/
static gboolean
}
/**
- * @brief Gets component layer
+ * @brief Gets component's layer
*
- * @param component an AtkComponent
- * @return component layer
+ * @param component AtkComponent instance
+ * @return AtkLayer representing the component's layer
*/
static AtkLayer
eail_widget_get_layer(AtkComponent *component)
/**
* @brief Gets the rectangle which gives the extent of the component
*
- * @param component an AtkComponent
- * @param [out] x rectangle upper left x coordinate
- * @param [out] y rectangle upper left y coordinate
- * @param [out] width component width
- * @param [out] height component height
+ * @param component AtkComponent instance
+ * @param [out] x upper left x coordinate of the rectangle
+ * @param [out] y upper left y coordinate of the rectangle
+ * @param [out] width width of the rectangle
+ * @param [out] height height of the rectangle
* @param coord_type coordinates type
*/
static void
/**
* @brief Sets component position
*
- * @param component an AtkComponent
+ * @param component AtkComponent instance
* @param x upper left x coordinate
* @param y upper left y coordinate
* @param coord_type coordinates type
/**
* @brief Sets component size
*
- * @param component an AtkComponent
- * @param width new width
- * @param height new height
+ * @param component AtkComponent instance
+ * @param width new width of component
+ * @param height new height of component
* @return TRUE on success, FALSE otherwise
*/
static gboolean
/**
* @brief Sets component extents
*
- * @param component an AtkComponent
- * @param x upper left x coordinate
- * @param y upper left y coordinate
- * @param width new width
- * @param height new height
+ * @param component AtkComponent instance
+ * @param x new upper left x coordinate
+ * @param y new upper left y coordinate
+ * @param width new width of component
+ * @param height new height of component
* @param coord_type coordinates type
* @return TRUE on success, FALSE otherwise
*/
/**
* @brief Sets function to execute whenever component gets focus
*
- * @param component an AtkComponent
- * @param handler an AtkFocusHandler
- * @returns handler id
+ * @param component AtkComponent instance
+ * @param handler AtkFocusHandler instance
+ * @returns integer representing the handler's id
*/
static guint
eail_widget_add_focus_handler(AtkComponent *component,
/**
* @brief AtkComponent interface initialization
*
- * @param iface EailNaviframPage object
+ * @param iface EailNaviframPage instance
*/
static void
atk_component_interface_init(AtkComponentIface *iface)
* @brief Macro upcasts an instance (obj) of a subclass to the EailWidget
* type
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_WIDGET(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), \
EAIL_TYPE_WIDGET, EailWidget))
/**
* @brief Tests whether object (obj) is an instance of EailWidget class
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_IS_WIDGET(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), \
EAIL_TYPE_WIDGET))
/** @brief Definition of object structure for Atk EailWidget*/
struct _EailWidget
{
- AtkObject parent;/**< @brief AtkObject that is being extended*/
+ AtkObject parent;/**< @brief Parent AtkObject whose functionality is being extended*/
- Evas_Object *widget;/**< @brief internal widget that is represented by EailWidget */
- AtkLayer layer;/**< @brief describes layer of a component (eg. ATK_LAYER_WIDGET) */
+ Evas_Object *widget;/**< @brief Internal widget that is represented by EailWidget */
+ AtkLayer layer;/**< @brief Describes layer of a component (eg. ATK_LAYER_WIDGET) */
};
/** @brief Definition of object class for Atk EailWidget*/
eail_dynamic_content_interface_init));
/**
- * @brief Maximize event handler
+ * @brief Maximizes event handler
*
- * @param data passed to callback
- * @param obj object that raised event
+ * @param data data passed to callback
+ * @param obj Evas_Object instance that raised event
* @param event_info additional event info
*/
void
}
/**
- * @brief Minimize event handler
+ * @brief Minimizes event handler
*
- * @param data passed to callback
- * @param obj object that raised event
+ * @param data data passed to callback
+ * @param obj Evas_Object instance that raised event
* @param event_info additional event info
*/
void
}
/**
- * @brief Move event handler
+ * @brief Moves event handler
*
- * @param data passed to callback
- * @param obj object that raised event
+ * @param data data passed to callback
+ * @param obj Evas_Object instance that raised event
* @param event_info additional event info
*/
void
}
/**
- * @brief Callback used to tracking "resize"-changes for window
+ * @brief Callback used for tracking resize-changes for window
*
* @param data data passed to callback
- * @param e an Evas that has been shown
- * @param obj an Evas_Object that has been shown
+ * @param e Evas instance that has been shown
+ * @param obj Evas_Object instance that has been shown
* @param event_info additional event info
*/
void
}
/**
- * @brief Initialize window focus handler
+ * @brief Initializes window focus handler
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
static void
eail_window_init_focus_handler(AtkObject *obj)
/**
* @brief EailWindow initializer
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
* @param data initialization data
*/
static void
}
/**
- * @brief Gets children list from given edje
+ * @brief Gets the children list from given edje
*
* @param edje lowest (stacked) Evas object
- * @return children list
+ * @return Eina_List representing the children list
*/
static Eina_List *
_parse_edje(const Evas_Object *edje)
}
/**
- * @brief Gets widget children
+ * @brief Gets widget's children
*
- * @param widget an EailWidget
- * @return widget list
+ * @param widget EailWidget instance
+ * @return Eina_List representing the list of widget's children
*/
static Eina_List *
eail_window_get_widget_children(EailWidget *widget)
}
/**
- * @brief Gets obj state set
+ * @brief Gets the state set of the accessible
*
- * @param obj an AtkObject
- * @return obj state set
+ * @param obj AtkObject instance
+ * @return AtkStateSet representing the state set of the accessible
*/
static AtkStateSet *
eail_window_ref_state_set(AtkObject *obj)
/**
* @brief EailWindow instance initializer
*
- * @param window an EailWindow
+ * @param window EailWindow instance
*/
static void
eail_window_init(EailWindow *window)
/**
* @brief EailWindow class initializer
*
- * @param klass an EailWindowClass
+ * @param klass EailWindowClass instance
*/
static void
eail_window_class_init(EailWindowClass *klass)
}
/**
- * @brief Handle for action minimize
+ * @brief Handle for minimize action
*
- * @param action an AtkAction
+ * @param action AtkAction instance
* @param data additional action data (not used here)
*
* @return TRUE if action was triggered successfully, FALSE otherwise
}
/**
- * @brief Handle for action maximize
+ * @brief Handle for maximize action
*
- * @param action an AtkAction
+ * @param action AtkAction instance
* @param data additional action data (not used here)
*
* @return TRUE if action was triggered successfully, FALSE otherwise
}
/**
- * @brief Adds window actions to actions table
+ * @brief Adds window actions to the actions table
*
* @param action_widget widget that implements EailActionWidget interface
*/
* It is empty because at the moment
* AtkWindow is just about signals
*
- * @param iface an AtkWindowIface
+ * @param iface AtkWindowIface instance
*/
static void
atk_window_interface_init(AtkWindowIface *iface)
}
/**
- * @brief Returns first found widget from EvasObjectBox
+ * @brief Returns the first found widget from EvasObjectBox
*
- * @param evas_obj an EvasObjectBox to search in
+ * @param evas_obj EvasObjectBox instance to search in
*
- * @returns Evas_Object* widget or NULL if none has been found
+ * @returns Evas_Object that represents the found widget
+ * or NULL if none has been found
*/
static Evas_Object*
_eail_get_first_widget_from_evas_box(Evas_Object *evas_obj)
}
/**
- * @brief Returns first found widget from given edje object
+ * @brief Returns the first found widget from given edje object
*
* @param evas_obj edje object to search in
*
- * @returns Evas_Object* widget or NULL if none has been found
+ * @returns Evas_Object that represents the found widget
+ * or NULL if none has been found
*/
static Evas_Object *
_eail_get_first_widget_from_edje(Evas_Object *evas_obj)
/**
* @brief Gets a reference to the accessible child, if one exists, at the
- * coordinate point specified by x and y.
+ * coordinate point specified by x and y
*
- * @param component the AtkComponent
+ * @param component AtkComponent instance
* @param x x coordinate
* @param y y coordinate
* @param coord_type specifies whether the coordinates are relative to the
* screen or to the components top level window
*
- * @returns a reference to the accessible child, if one exists.
+ * @returns AtkObject representing the accessible child, if one exists
*/
static AtkObject *
eail_window_ref_accessible_at_point(AtkComponent *component,
* reference object at given coordinates. Rest of implementation is default
* so no overriding-callbacks is needed.
*
- * @param iface EailWindow object
+ * @param iface EailWindow instance
*/
static void
atk_component_interface_init(AtkComponentIface *iface)
* @brief Macro upcasts an instance (obj) of a subclass to the EailWindow
* type
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_WINDOW(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), \
EAIL_TYPE_WINDOW, EailWindow))
/**
* @brief Tests whether object (obj) is an instance of EailWindow class
*
- * @param obj an AtkObject
+ * @param obj AtkObject instance
*/
#define EAIL_IS_WINDOW(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), \
EAIL_TYPE_WINDOW))
/** @brief Definition of object structure for Atk EailWindow*/
struct _EailWindow
{
- EailActionWidget parent;/*!< @brief object that functionality is being extended*/
- gint child_count_last;/**< @brief last reported count of children */
+ EailActionWidget parent;/*!< @brief Parent widget whose functionality is being extended*/
};
/** @brief Definition of object class for Atk EailWindow*/
projects / platform / core / uifw / eail.git / commitdiff