#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
projects / platform / core / uifw / eail.git / blobdiff