#include <Elementary.h>
#include "elm_priv.h"
+/**
+ * @defgroup Bubble Bubble
+ *
+ * The Bubble is an widget used to show a text in a frame as speach is
+ * represented in comics.
+ *
+ */
+
+
typedef struct _Widget_Data Widget_Data;
struct _Widget_Data
}
}
+/**
+ * Add a new bubble to the parent
+ *
+ * @param parent The parent object
+ * @return The new object or NULL if it cannot be created
+ *
+ * This function adds a text bubble to the given parent evas object.
+ *
+ * @ingroup Bubble
+ */
EAPI Evas_Object *
elm_bubble_add(Evas_Object *parent)
{
return obj;
}
+/**
+ * Set the label of the bubble
+ *
+ * @param obj The given evas pointer
+ * @param label The string to set in the label
+ *
+ * This function sets the title of the bubble that is showed on top of
+ * the bubble.
+ *
+ * @ingroup Bubble
+ */
EAPI void
elm_bubble_label_set(Evas_Object *obj, const char *label)
{
return wd->label;
}
+/**
+ * Set the info of the bubble
+ *
+ * @param obj The given evas pointer
+ * @param info The given info about the bubble
+ *
+ * This function sets the text showed on the top right of bubble In
+ * the Anchorblock example of the Elementary tests application it
+ * shows time.
+ *
+ * @ingroup Bubble
+ *
+ */
EAPI void
elm_bubble_info_set(Evas_Object *obj, const char *info)
{
edje_object_part_text_set(wd->bbl, "elm.info", info);
_sizing_eval(obj);
}
-
+/**
+ * Set the text to be showed in the bubble
+ *
+ * @param obj The given evas pointer
+ * @param content The given info about the bubble
+ *
+ * This function sets the text showed on the top right of bubble. In
+ * the Anchorblock example of the Elementary tests application it
+ * shows time.
+ *
+ * @ingroup Bubble
+ */
EAPI void
elm_bubble_content_set(Evas_Object *obj, Evas_Object *content)
{
_sizing_eval(obj);
}
+/**
+ * Set the icon of the bubble
+ *
+ * @param obj The given evas pointer
+ * @param icon The given icon for the bubble
+ *
+ * This function sets the icon showed on the top left of bubble.
+ *
+ * @ingroup Bubble
+ */
EAPI void
elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon)
{
return wd->icon;
}
+/**
+ * Set the corner of the bubble
+ *
+ * @param obj The given evas pointer.
+ * @param corner The given corner for the bubble.
+ *
+ * This function sets the corner of the bubble.
+ *
+ * @ingroup Bubble
+ */
EAPI void
elm_bubble_corner_set(Evas_Object *obj, const char *corner)
{
#include <Elementary.h>
#include "elm_priv.h"
+/**
+ * @defgroup Button Button
+ *
+ * This is a push-button. Press it and run some function. It can contain
+ * a simple label and icon object.
+ */
+
typedef struct _Widget_Data Widget_Data;
struct _Widget_Data
evas_object_smart_callback_call(data, "clicked", NULL);
}
+/**
+ * Add a new button to the parent
+ * @param parent The parent object
+ * @return The new object or NULL if it cannot be created
+ *
+ * @ingroup Button
+ */
EAPI Evas_Object *
elm_button_add(Evas_Object *parent)
{
return obj;
}
+/**
+ * Set the label used in the button
+ *
+ * @param obj The button object
+ * @param label The text will be written on the button
+ *
+ * @ingroup Button
+ */
EAPI void
elm_button_label_set(Evas_Object *obj, const char *label)
{
return wd->label;
}
+/**
+ * Set the icon used for the button
+ *
+ * @param obj The button object
+ * @param icon The image for the button
+ *
+ * @ingroup Button
+ */
EAPI void
elm_button_icon_set(Evas_Object *obj, Evas_Object *icon)
{
return wd->icon;
}
+/**
+ * Set the button style
+ *
+ * @param obj The button object
+ * @param style The style for the button
+ *
+ * @ingroup Button
+ */
EAPI void
elm_button_style_set(Evas_Object *obj, const char *style)
{
#include <Elementary.h>
#include "elm_priv.h"
+/**
+ * @defgroup Clock Clock
+ *
+ * It's a widget to show clock with animation. The update of time is
+ * showed in an animation like a flip of a sheet.
+ *
+ */
+
typedef struct _Widget_Data Widget_Data;
struct _Widget_Data
wd->cur.ampm = -1;
}
+/**
+ * Add a new clock to the parent
+ *
+ * @param parent The parent object
+ *
+ * This function inserts a clock widget on a given canvas to show a
+ * animated clock.
+ *
+ * @ingroup Clock
+ */
EAPI Evas_Object *
elm_clock_add(Evas_Object *parent)
{
return obj;
}
+/**
+ * Set the clock time
+ *
+ * @param obj The clock object
+ * @param hrs The hours to set
+ * @param min The minutes to set
+ * @param sec The secondes to set
+ *
+ * This function updates the time that is showed by the clock widget
+ *
+ * @ingroup Clock
+ */
EAPI void
elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec)
{
_time_update(obj);
}
+/**
+ * Get clock time
+ *
+ * @param obj The clock object
+ * @param hrs Pointer to the variable to get the hour of this clock
+ * object
+ * @param min Pointer to the variable to get the minute of this clock
+ * object
+ * @param sec Pointer to the variable to get the second of this clock
+ * object
+ *
+ * This function gets the time set of the clock widget and returns it
+ * on the variables passed as the arguments to function
+ *
+ * @ingroup Clock
+ */
EAPI void
elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec)
{
if (sec) *sec = wd->sec;
}
+/**
+ * Set if the clock settings can be edited
+ *
+ * @param obj The clock object
+ * @param edit Bool option for edited (1 = yes, 0 = no)
+ *
+ * This function sets if the clock settings can be edited or not.
+ *
+ * @ingroup Clock
+ */
EAPI void
elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit)
{
_time_update(obj);
}
+/**
+ * Set if the clock show hours in military or am/pm mode
+ *
+ * @param obj The clock object
+ * @param am_pm Bool option for the hours mode
+ * (1 = am/pm, 0 = military)
+ *
+ * This function sets the clock to show hours in military or am/pm
+ * mode. Some countries like Brazil the military mode (00-24h-format)
+ * is used in opposition to the USA where the am/pm mode is more
+ * common used.
+ *
+ * @ingroup Clock
+ */
EAPI void
elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm)
{
_time_update(obj);
}
+/**
+ * Set if the clock show hour with the seconds
+ *
+ * @param obj The clock object
+ * @param seconds Bool option for the show seconds
+ * (1 = show seconds, 0 = not show seconds)
+ *
+ * This function sets the clock to show or not to show the elapsed
+ * seconds.
+ *
+ * @ingroup Clock
+ */
EAPI void
elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds)
{
#include <Elementary.h>
#include "elm_priv.h"
+/**
+ * @defgroup Frame Frame
+ *
+ * This holds some content and has a title. Looks like a frame, but
+ * supports styles so multple frames are avaible
+ */
+
typedef struct _Widget_Data Widget_Data;
struct _Widget_Data
}
}
+/**
+ * Add a new frame to the parent
+ *
+ * @param parent The parent object
+ * @return The new object or NULL if it cannot be created
+ *
+ * @ingroup Frame
+ */
EAPI Evas_Object *
elm_frame_add(Evas_Object *parent)
{
return obj;
}
+/**
+ * Set the frame label
+ *
+ * @param obj The frame object
+ * @param label The label of this frame object
+ *
+ * @ingroup Frame
+ */
EAPI void
elm_frame_label_set(Evas_Object *obj, const char *label)
{
_sizing_eval(obj);
}
+/**
+ * Get the frame label
+ *
+ * @param obj The frame object
+ *
+ * @return The label of this frame objet or NULL if unable to get frame
+ *
+ * @ingroup Frame
+ */
EAPI const char*
elm_frame_label_get(Evas_Object *obj)
{
return edje_object_part_text_get(wd->frm, "elm.text");
}
+/**
+ * Set the frame content
+ *
+ * @param obj The frame object
+ * @param content The content will be filled in this frame object
+ *
+ * @ingroup Frame
+ */
EAPI void
elm_frame_content_set(Evas_Object *obj, Evas_Object *content)
{
}
}
+/**
+ * Set the frame style
+ *
+ * @param obj The frame object
+ * @param style The style will be applied in this frame
+ *
+ * @ingroup Frame
+ */
EAPI void
elm_frame_style_set(Evas_Object *obj, const char *style)
{
* item @p it.
*
* @param it The item
- * @param selcted The slected state
+ * @param selected The slected state
*
* @ingroup Genlist
*/
#include <Elementary.h>
#include "elm_priv.h"
+/**
+ * @defgroup Icon Icon
+ *
+ * A standard icon that may be provided by the theme (delete, edit,
+ * arrows etc.) or a custom file (PNG, JPG, EDJE etc.) used for an
+ * icon. The Icon may scale or not and of course... support alpha
+ * channels.
+ */
+
typedef struct _Widget_Data Widget_Data;
struct _Widget_Data
evas_object_smart_callback_call(data, "clicked", event_info);
}
+/**
+ * Add a new icon to the parent
+ *
+ * @param parent The parent object
+ * @return The new object or NULL if it cannot be created
+ *
+ * @ingroup Icon
+ */
EAPI Evas_Object *
elm_icon_add(Evas_Object *parent)
{
return obj;
}
+/**
+ * Set the file that will be used as icon
+ *
+ * @param obj The icon object
+ * @param file The path to file that will be used as icon
+ * @param group The group that the icon belongs in edje file
+ *
+ * @return (1 = sucess, 0 = error)
+ *
+ * @ingroup Icon
+ */
EAPI Eina_Bool
elm_icon_file_set(Evas_Object *obj, const char *file, const char *group)
{
return ret;
}
+/**
+ * Set the theme, as standard, for a icon
+ *
+ * @param obj The icon object
+ * @param name The theme name
+ *
+ * @ingroup Icon
+ */
EAPI void
elm_icon_standard_set(Evas_Object *obj, const char *name)
{
_sizing_eval(obj);
}
+/**
+ * Set the smooth effect for a icon
+ *
+ * @param obj The icon object
+ * @param smooth A bool to set (or no) smooth effect
+ * (1 = smooth, 0 = not smooth)
+ *
+ * @ingroup Icon
+ */
EAPI void
elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth)
{
_sizing_eval(obj);
}
+/**
+ * Set if the object are scalable
+ *
+ * @param obj The icon object
+ * @param no_scale A bool to set scale (or no)
+ * (1 = no_scale, 0 = scale)
+ *
+ * @ingroup Icon
+ */
EAPI void
elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale)
{
_sizing_eval(obj);
}
+/**
+ * Set if the object is (up/down) scalable
+ *
+ * @param obj The icon object
+ * @param scale_up A bool to set if the object is scalable up
+ * @param scale_down A bool to set if the object is scalable down
+ *
+ * @ingroup Icon
+ */
EAPI void
elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down)
{
_sizing_eval(obj);
}
+/**
+ * Set if the object is filled outside
+ *
+ * @param obj The icon object
+ * @param fill_outside A bool to set if the object is filled outside
+ * (1 = filled, 0 = no filled)
+ *
+ * @ingroup Icon
+ */
EAPI void
elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside)
{
_sizing_eval(obj);
}
+
+/**
+ * Set the prescale size for the icon
+ *
+ * @param obj The icon object
+ * @param size The prescale size
+ *
+ * @ingroup Icon
+ */
EAPI void
elm_icon_prescale_set(Evas_Object *obj, int size)
{
#include <Elementary.h>
#include "elm_priv.h"
+/**
+ * @defgroup Image Image
+ *
+ * A standard image that may be provided by the theme (delete, edit,
+ * arrows etc.) or a custom file (PNG, JPG, EDJE etc.) used for an
+ * icon. The Icon may scale or not and of course... support alpha
+ * channels.
+ */
+
typedef struct _Widget_Data Widget_Data;
struct _Widget_Data
evas_object_smart_callback_call(data, "clicked", NULL);
}
+/**
+ * Add a new image to the parent
+ *
+ * @param parent The parent object
+ * @return The new object or NULL if it cannot be created
+ *
+ * @ingroup Image
+ */
EAPI Evas_Object *
elm_image_add(Evas_Object *parent)
{
return obj;
}
+/**
+ * Set the file that will be used as image
+ *
+ * @param obj The image object
+ * @param file The path to file that will be used as image
+ * @param group The group that the image belongs in edje file
+ *
+ * @return (1 = sucess, 0 = error)
+ *
+ * @ingroup Image
+ */
EAPI Eina_Bool
elm_image_file_set(Evas_Object *obj, const char *file, const char *group)
{
return ret;
}
+/**
+ * Set the smooth effect for a image
+ *
+ * @param obj The image object
+ * @param smooth A bool to set (or no) smooth effect
+ * (1 = smooth, 0 = not smooth)
+ *
+ * @ingroup Image
+ */
EAPI void
elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth)
{
_els_smart_icon_size_get(wd->img, w, h);
}
+/**
+ * Set if the object are scalable
+ *
+ * @param obj The image object.
+ * @param no_scale A bool to set scale (or no).
+ * (1 = no_scale, 0 = scale)
+ *
+ * @ingroup Image
+ */
EAPI void
elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale)
{
if (!wd) return;
wd->no_scale = no_scale;
_sizing_eval(obj);
+
}
+/**
+ * Set if the object is (up/down) scalable
+ *
+ * @param obj The image object
+ * @param scale_up A bool to set if the object is scalable up
+ * @param scale_down A bool to set if the object is scalable down
+ *
+ * @ingroup Image
+ */
EAPI void
elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down)
{
_sizing_eval(obj);
}
+/**
+ * Set if the object is filled outside
+ *
+ * @param obj The image object
+ * @param fill_outside A bool to set if the object is filled outside
+ * (1 = filled, 0 = no filled)
+ *
+ * @ingroup Image
+ */
EAPI void
elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside)
{
_sizing_eval(obj);
}
+/**
+ * Set the prescale size for the image
+ *
+ * @param obj The image object
+ * @param size The prescale size
+ *
+ * @ingroup Image
+ */
EAPI void
elm_image_prescale_set(Evas_Object *obj, int size)
{
_els_smart_icon_scale_size_set(wd->img, size);
}
+/**
+ * Set the image orient
+ *
+ * @param obj The image object
+ * @param orient The image orient
+ * (ELM_IMAGE_ORIENT_NONE, ELM_IMAGE_ROTATE_90_CW,
+ * ELM_IMAGE_ROTATE_180_CW, ELM_IMAGE_ROTATE_90_CCW,
+ * ELM_IMAGE_FLIP_HORIZONTAL,ELM_IMAGE_FLIP_VERTICAL,
+ * ELM_IMAGE_FLIP_TRANSPOSE, ELM_IMAGE_FLIP_TRANSVERSE)
+ *
+ * @ingroup Image
+ */
EAPI void
elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient)
{
}
/**
- * XXX
+ * @brief To be documented.
*
- * @param obj The index object
+ * @param obj The index object.
+ * @param level To be documented.
*
* @ingroup Index
*/
}
/**
- * XXX
+ * @brief To be documented.
*
* @param obj The index object
*
}
/**
- * XXX
+ * @brief To be documented.
*
- * @param obj The index object
+ * @param obj The index object.
+ * @param level to be documented.
*
* @ingroup Index
*/
}
/**
- * XXX
+ * @brief To be documented.
*
- * @param obj The index object
+ * @param obj The index object.
+ * @param letter to be documented.
+ * @param item to be documented.
*
* @ingroup Index
*/
}
/**
- * XXX
+ * @brief To be documented.
*
- * @param obj The index object
+ * @param obj The index object.
+ * @param letter to be documented.
+ * @param item to be documented.
*
* @ingroup Index
*/
}
/**
- * XXX
+ * @brief To be documented.
*
* @param obj The index object
+ * @param letter to be documented.
+ * @param item to be documented.
+ * @param relative to be documented.
*
* @ingroup Index
*/
}
/**
- * XXX
+ * @brief To be documented.
*
- * @param obj The index object
+ * @param obj The index object.
+ * @param letter to be documented.
+ * @param item to be documented.
+ * @param relative to be documented.
*
* @ingroup Index
*/
}
/**
- * XXX
+ * @brief To be documented.
*
* @param obj The index object
+ * @param item To be documented.
*
* @ingroup Index
*/
}
/**
- * XXX
+ * @brief To be documented.
*
- * @param obj The index object
+ * @param obj The index object.
*
* @ingroup Index
*/
}
/**
- * XXX
+ * @brief To be documented.
*
* @param obj The index object
+ * @param level To be documented.
*
* @ingroup Index
*/
#include <Elementary.h>
#include "elm_priv.h"
+/**
+ * @defgroup Label Label
+ *
+ * Display text, with simple html-like markup. The theme of course
+ * can invent new markup tags and style them any way it likes
+ */
+
typedef struct _Widget_Data Widget_Data;
struct _Widget_Data
evas_object_size_hint_max_set(obj, maxw, maxh);
}
+/**
+ * Add a new label to the parent
+ *
+ * @param parent The parent object
+ * @return The new object or NULL if it cannot be created
+ *
+ * @ingroup Label
+ */
EAPI Evas_Object *
elm_label_add(Evas_Object *parent)
{
return obj;
}
+/**
+ * Set the label on the label object
+ *
+ * @param obj The label object
+ * @param label The label will be used on the label object
+ *
+ * @ingroup Label
+ */
EAPI void
elm_label_label_set(Evas_Object *obj, const char *label)
{
_sizing_eval(obj);
}
+/**
+ * Get the label used on the label object
+ *
+ * @param obj The label object
+ *
+ * @ingroup Label
+ */
EAPI const char*
elm_label_label_get(Evas_Object *obj)
{
#include <Elementary.h>
#include "elm_priv.h"
+/**
+ * @defgroup Layout Layout
+ *
+ * This takes a standard Edje design file and wraps it very thinly
+ * in a widget and handles swallowing widgets into swallow regions
+ * in the Edje object, allowing Edje to be used as a design and
+ * layout tool
+ */
+
typedef struct _Widget_Data Widget_Data;
typedef struct _Subinfo Subinfo;
}
}
+/**
+ * Add a new layout to the parent
+ *
+ * @param parent The parent object
+ * @return The new object or NULL if it cannot be created
+ *
+ * @ingroup Layout
+ */
EAPI Evas_Object *
elm_layout_add(Evas_Object *parent)
{
return obj;
}
+/**
+ * Set the file that will be used as layout
+ *
+ * @param obj The layout object
+ * @param file The path to file (edj) that will be used as layout
+ * @param group The group that the layout belongs in edje file
+ *
+ * @return (1 = sucess, 0 = error)
+ *
+ * @ingroup Layout
+ */
EAPI Eina_Bool
elm_layout_file_set(Evas_Object *obj, const char *file, const char *group)
{
return ret;
}
+/**
+ * Set the layout content
+ *
+ * @param obj The layout object
+ * @param swallow The swallow group name in the edje file
+ * @param content The content will be filled in this layout object
+ *
+ * @ingroup Layout
+ */
EAPI void
elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content)
{
}
}
+/**
+ * Get the edje layout
+ *
+ * @param obj The layout object
+ *
+ * @return A Evas_Object with the edje layout settings loaded
+ * with function elm_layout_file_set
+ *
+ * @ingroup Layout
+ */
EAPI Evas_Object *
elm_layout_edje_get(const Evas_Object *obj)
{
*
* This sets the globally configured finger size in pixels
*
- * @paramsize The finger size
+ * @param size The finger size
* @ingroup Fingers
*/
EAPI void
#include <Elementary.h>
#include "elm_priv.h"
+/**
+ * @defgroup Photo Photo
+ *
+ * For displaying the photo of a person (contact). Simple yet
+ * with a very specific purpose.
+ */
+
typedef struct _Widget_Data Widget_Data;
struct _Widget_Data
evas_object_smart_callback_call(data, "clicked", NULL);
}
+/**
+ * Add a new photo to the parent
+ *
+ * @param parent The parent object
+ * @return The new object or NULL if it cannot be created
+ *
+ * @ingroup Photo
+ */
EAPI Evas_Object *
elm_photo_add(Evas_Object *parent)
{
return obj;
}
+/**
+ * Set the file that will be used as photo
+ *
+ * @param obj The photo object
+ * @param file The path to file that will be used as photo
+ *
+ * @return (1 = sucess, 0 = error)
+ *
+ * @ingroup Photo
+ */
EAPI Eina_Bool
elm_photo_file_set(Evas_Object *obj, const char *file)
{
return 1;
}
+/**
+ * Set the size that will be used on the photo
+ *
+ * @param obj The photo object
+ * @param size The size that the photo will be
+ *
+ * @ingroup Photo
+ */
EAPI void
elm_photo_size_set(Evas_Object *obj, int size)
{
* (the cursor pulse right to left and left to right, and loop) if pulse is set to 1.
*
* @param obj The progressbar object
- * @param pulse The pulse flag. 1 == pulse, 0 == normal
+ * @param state The pulse flag. 1 == pulse, 0 == normal
*
* @ingroup Progressbar
*/
}
/**
- * Set the value the radio
+ * Set the value of the radio.
*
* This sets the value of the radio group and will also set the value if
* pointed to, to the value supplied, but will not call any callbacks.
*
* @param obj The radio object
- * @param state The value to use for the group
+ * @param value The value to use for the group
*
* @ingroup Radio
*/
* information on how this works.
*
* @param obj The slider object
- * @param units The format string for the indicator display
+ * @param indicator The format string for the indicator display
*
* @ingroup Slider
*/
#include <Elementary.h>
#include "elm_priv.h"
+/**
+ * @defgroup Table Table
+ *
+ * Arranges widgets in a table where items can also span multiple
+ * columns or rows - even overlap (and then be raised or lowered
+ * accordingly to adjust stacking if they do overlap).
+ */
+
typedef struct _Widget_Data Widget_Data;
struct _Widget_Data
_sizing_eval(obj);
}
+/**
+ * Add a new table to the parent
+ *
+ * @param parent The parent object
+ * @return The new object or NULL if it cannot be created
+ *
+ * @ingroup Table
+ */
EAPI Evas_Object *
elm_table_add(Evas_Object *parent)
{
return obj;
}
+/**
+ * Set the homogenous layout in the table
+ *
+ * @param obj The layout object
+ * @param homogenous A boolean to set (or no) layout homogenous
+ * in the table
+ * (1 = homogenous, 0 = no homogenous)
+ *
+ * @ingroup Table
+ */
EAPI void
elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous)
{
_els_smart_table_homogenous_set(wd->tbl, homogenous);
}
+/**
+ * Add a subobject on the table with the coordinates passed
+ *
+ * @param obj The table object
+ * @param subobj The subobject to be added to the table
+ * @param x Coordinate to X axis
+ * @param y Coordinate to Y axis
+ * @param w Horizontal length
+ * @param h Vertical length
+ *
+ * @ingroup Table
+ */
EAPI void
elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h)
{
projects / platform / upstream / elementary.git / commitdiff