And document the wiget API

This commit is contained in:
Andy Williams 2015-01-26 23:09:22 +00:00
parent 09ac58f30e
commit ba60959058
3 changed files with 73 additions and 19 deletions

View File

@ -5,29 +5,62 @@ class Elm_Code_Widget (Elm_Box, Elm_Interface_Scrollable,
properties {
code {
set {
/*@
Set the underlying code object that this widget renders
@ingroup Data */
}
get {
/*@
Get the underlying code object we are rendering
@ingroup Data */
}
values {
Elm_Code *code;
Elm_Code *code; /*@ Our underlying Elm_Code object */
}
}
font_size {
set {
/*@
Set the font size that this widget uses, the font will always be a system monospaced font
@ingroup Style */
}
get {
/*@
Get the font size currently in use
@ingroup Style */
}
values {
Evas_Font_Size font_size;
Evas_Font_Size font_size; /*@ The font size of the widgget */
}
}
editable {
set {
/*@
Set whether this widget allows editing
If @a editable then the widget will allow user input to manipulate
the underlying Elm_Code_File of this Elm_Code instance.
Any other Elm_Code_Widget's connected to this Elm_Code will
update to reflect the changes.
@ingroup Features */
}
get {
/*@
Get the current editable state of this widget
@return EINA_TRUE if the widget is editable, EINA_FALSE otherwise.
If this widget is not editable the underlying Elm_Code_File could
still be manipulated by a different widget or the filesystem.
@ingroup Features */
}
values {
Eina_Bool editable;
Eina_Bool editable; /*@ The editable state of the widget */
}
}
}

View File

@ -42,12 +42,12 @@ static Eo_Op_Description _elm_code_widget_op_desc[] = {
EO_OP_FUNC_OVERRIDE(evas_obj_smart_add, _elm_code_widget_evas_object_smart_add),
EO_OP_FUNC_OVERRIDE(elm_obj_widget_on_focus, _elm_code_widget_elm_widget_on_focus),
EO_OP_FUNC_OVERRIDE(elm_interface_scrollable_content_pos_set, _elm_code_widget_elm_interface_scrollable_content_pos_set),
EO_OP_FUNC(elm_code_widget_code_set, _elm_code_widget_code_set, ""),
EO_OP_FUNC(elm_code_widget_code_get, _elm_code_widget_code_get, ""),
EO_OP_FUNC(elm_code_widget_font_size_set, _elm_code_widget_font_size_set, ""),
EO_OP_FUNC(elm_code_widget_font_size_get, _elm_code_widget_font_size_get, ""),
EO_OP_FUNC(elm_code_widget_editable_set, _elm_code_widget_editable_set, ""),
EO_OP_FUNC(elm_code_widget_editable_get, _elm_code_widget_editable_get, ""),
EO_OP_FUNC(elm_code_widget_code_set, _elm_code_widget_code_set, "Set the underlying code object that this widget renders"),
EO_OP_FUNC(elm_code_widget_code_get, _elm_code_widget_code_get, "Get the underlying code object we are rendering"),
EO_OP_FUNC(elm_code_widget_font_size_set, _elm_code_widget_font_size_set, "Set the font size that this widget uses, the font will always be a system monospaced font"),
EO_OP_FUNC(elm_code_widget_font_size_get, _elm_code_widget_font_size_get, "Get the font size currently in use"),
EO_OP_FUNC(elm_code_widget_editable_set, _elm_code_widget_editable_set, "Set whether this widget allows editing"),
EO_OP_FUNC(elm_code_widget_editable_get, _elm_code_widget_editable_get, "Get the current editable state of this widget"),
EO_OP_SENTINEL
};
@ -67,4 +67,4 @@ static const Eo_Class_Description _elm_code_widget_class_desc = {
NULL
};
EO_DEFINE_CLASS(elm_code_widget_class_get, &_elm_code_widget_class_desc, ELM_BOX_CLASS, ELM_INTERFACE_SCROLLABLE_MIXIN, ELM_INTERFACE_ATSPI_TEXT_INTERFACE, NULL);
EO_DEFINE_CLASS(elm_code_widget_class_get, &_elm_code_widget_class_desc, ELM_BOX_CLASS, ELM_INTERFACE_SCROLLABLE_MIXIN, ELM_INTERFACE_ATSPI_TEXT_INTERFACE, NULL);

View File

@ -19,16 +19,20 @@ const Eo_Class *elm_code_widget_class_get(void) EINA_CONST;
/**
*
* No description supplied.
* Set the underlying code object that this widget renders
*
* @param[in] code No description supplied.
* @ingroup Data
*
* @param[in] code Our underlying Elm_Code object
*
*/
EOAPI void elm_code_widget_code_set(Elm_Code *code);
/**
*
* No description supplied.
* Get the underlying code object we are rendering
*
* @ingroup Data
*
*
*/
@ -36,16 +40,20 @@ EOAPI Elm_Code * elm_code_widget_code_get(void);
/**
*
* No description supplied.
* Set the font size that this widget uses, the font will always be a system monospaced font
*
* @param[in] font_size No description supplied.
* @ingroup Style
*
* @param[in] font_size The font size of the widgget
*
*/
EOAPI void elm_code_widget_font_size_set(Evas_Font_Size font_size);
/**
*
* No description supplied.
* Get the font size currently in use
*
* @ingroup Style
*
*
*/
@ -53,16 +61,29 @@ EOAPI Evas_Font_Size elm_code_widget_font_size_get(void);
/**
*
* No description supplied.
* Set whether this widget allows editing
*
* @param[in] editable No description supplied.
* If @a editable then the widget will allow user input to manipulate
* the underlying Elm_Code_File of this Elm_Code instance.
* Any other Elm_Code_Widget's connected to this Elm_Code will
* update to reflect the changes.
*
* @ingroup Features
*
* @param[in] editable The editable state of the widget
*
*/
EOAPI void elm_code_widget_editable_set(Eina_Bool editable);
/**
*
* No description supplied.
* Get the current editable state of this widget
*
* @return EINA_TRUE if the widget is editable, EINA_FALSE otherwise.
* If this widget is not editable the underlying Elm_Code_File could
* still be manipulated by a different widget or the filesystem.
*
* @ingroup Features
*
*
*/