forked from enlightenment/efl
docs: elm_code: add missing documentation for elm code widget
This commit is contained in:
parent
7cdc247b51
commit
1edeb4a7c6
|
@ -8,6 +8,7 @@ struct @extern Elm_Code_Line; [[Elementary code line data structure]] /* Parts o
|
||||||
|
|
||||||
class Elm.Code_Widget (Elm.Layout, Elm.Interface.Atspi.Text)
|
class Elm.Code_Widget (Elm.Layout, Elm.Interface.Atspi.Text)
|
||||||
{
|
{
|
||||||
|
[[Elementary code widget]]
|
||||||
eo_prefix: elm_obj_code_widget;
|
eo_prefix: elm_obj_code_widget;
|
||||||
legacy_prefix: elm_code_widget;
|
legacy_prefix: elm_code_widget;
|
||||||
methods {
|
methods {
|
||||||
|
@ -156,7 +157,7 @@ class Elm.Code_Widget (Elm.Layout, Elm.Interface.Atspi.Text)
|
||||||
[[Get whether or not space characters will be inserted instead of tabs.]]
|
[[Get whether or not space characters will be inserted instead of tabs.]]
|
||||||
}
|
}
|
||||||
values {
|
values {
|
||||||
tab_inserts_spaces: bool; [[EINA_TRUE if we should insert space characters instead of a tab when the Tab key is pressed]]
|
tab_inserts_spaces: bool; [[$true if we should insert space characters instead of a tab when the Tab key is pressed]]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@property cursor_position {
|
@property cursor_position {
|
||||||
|
@ -172,74 +173,84 @@ class Elm.Code_Widget (Elm.Layout, Elm.Interface.Atspi.Text)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
line_refresh {
|
line_refresh {
|
||||||
|
[[Refresh code line in widget]]
|
||||||
params {
|
params {
|
||||||
line: Elm_Code_Line *; [[The line to refresh.]]
|
line: Elm_Code_Line *; [[The line to refresh.]]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
line_visible_get {
|
line_visible_get {
|
||||||
|
[[Check if the code line is currently visible]]
|
||||||
params {
|
params {
|
||||||
line: Elm_Code_Line *; [[The line to test for visibility.]]
|
line: Elm_Code_Line *; [[The line to test for visibility.]]
|
||||||
}
|
}
|
||||||
return: bool; [[true if the line specified is currently visible within the scroll region.]]
|
return: bool; [[$true if the line specified is currently visible within the scroll region.]]
|
||||||
}
|
}
|
||||||
lines_visible_get {
|
lines_visible_get {
|
||||||
|
[[Get the number of code lines currently visible in the widget]]
|
||||||
return: uint; [[the number of lines currently visible in the widget.]]
|
return: uint; [[the number of lines currently visible in the widget.]]
|
||||||
}
|
}
|
||||||
position_at_coordinates_get {
|
position_at_coordinates_get {
|
||||||
[[get the row, col position for a given coordinate on the widget.]]
|
[[Get the row, col position for a given coordinate on the widget.]]
|
||||||
params {
|
params {
|
||||||
x: Evas.Coord; [[the x coordinate in the widget]]
|
x: Evas.Coord; [[The x coordinate in the widget]]
|
||||||
y: Evas.Coord; [[the y coordinate in the widget]]
|
y: Evas.Coord; [[The y coordinate in the widget]]
|
||||||
row: uint *; [[the row for the coordinates]]
|
row: uint *; [[The row for the coordinates]]
|
||||||
col: int *; [[the column for the coordinates]]
|
col: int *; [[The column for the coordinates]]
|
||||||
}
|
}
|
||||||
return: bool; [[true if a line exists at these coordinates]]
|
return: bool; [[$true if a line exists at these coordinates]]
|
||||||
}
|
}
|
||||||
|
|
||||||
//text functions
|
|
||||||
text_left_gutter_width_get {
|
text_left_gutter_width_get {
|
||||||
return: int; [[the current column width of the gutter for the widget.]]
|
[[Get the column width of the gutter]]
|
||||||
|
return: int; [[The current column width of the gutter for the widget.]]
|
||||||
}
|
}
|
||||||
text_line_number_width_get {
|
text_line_number_width_get {
|
||||||
return: int; [[the column width required to represent the number of lines in the widget.]]
|
[[Get the required column width]]
|
||||||
|
return: int; [[The column width required to represent the number of lines in the widget.]]
|
||||||
}
|
}
|
||||||
text_between_positions_get {
|
text_between_positions_get {
|
||||||
|
[[Get text between given positions]]
|
||||||
params {
|
params {
|
||||||
start_col: uint; [[the widget column of the first character to get]]
|
start_col: uint; [[The widget column of the first character to get]]
|
||||||
start_line: uint; [[the line of the first character to get]]
|
start_line: uint; [[The line of the first character to get]]
|
||||||
end_col: uint; [[the widget column of the last character to get]]
|
end_col: uint; [[The widget column of the last character to get]]
|
||||||
end_line: uint; [[the line of the last character to get]]
|
end_line: uint; [[The line of the last character to get]]
|
||||||
}
|
}
|
||||||
return: char *; [[the text content between start and end positions]]
|
return: char *; [[The text content between start and end positions]]
|
||||||
}
|
}
|
||||||
|
|
||||||
line_text_column_width_to_position {
|
line_text_column_width_to_position {
|
||||||
|
[[Get text column width at given position]]
|
||||||
params {
|
params {
|
||||||
line: Elm_Code_Line *;
|
line: Elm_Code_Line *; [[Code line]]
|
||||||
position: uint;
|
position: uint; [[Code position]]
|
||||||
}
|
}
|
||||||
return: uint;
|
return: uint; [[Text column width]]
|
||||||
}
|
}
|
||||||
line_text_column_width_get {
|
line_text_column_width_get {
|
||||||
|
[[Get text column width for code line]]
|
||||||
params {
|
params {
|
||||||
line: Elm_Code_Line *;
|
line: Elm_Code_Line *; [[Code line]]
|
||||||
}
|
}
|
||||||
return: uint;
|
return: uint; [[Text column width]]
|
||||||
}
|
}
|
||||||
line_text_position_for_column_get {
|
line_text_position_for_column_get {
|
||||||
|
[[Get position from column]]
|
||||||
params {
|
params {
|
||||||
line: Elm_Code_Line *;
|
line: Elm_Code_Line *; [[Code line]]
|
||||||
column: uint;
|
column: uint; [[Column]]
|
||||||
}
|
}
|
||||||
return: uint;
|
return: uint; [[Position]]
|
||||||
}
|
}
|
||||||
text_tabwidth_at_column_get {
|
text_tabwidth_at_column_get {
|
||||||
|
[[Get tabwidth for column]]
|
||||||
params {
|
params {
|
||||||
column: uint;
|
column: uint; [[Column]]
|
||||||
}
|
}
|
||||||
return: uint;
|
return: uint; [[Tabwidth]]
|
||||||
}
|
}
|
||||||
undo {
|
undo {
|
||||||
|
[[Undo last action]]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
implements {
|
implements {
|
||||||
|
@ -255,12 +266,11 @@ class Elm.Code_Widget (Elm.Layout, Elm.Interface.Atspi.Text)
|
||||||
.code;
|
.code;
|
||||||
}
|
}
|
||||||
events {
|
events {
|
||||||
line,clicked;
|
line,clicked; [[Called when text line was clicked]]
|
||||||
line,gutter,clicked;
|
line,gutter,clicked; [[Called when gutter was clicked]]
|
||||||
cursor,changed;
|
cursor,changed; [[Called when cursor changed]]
|
||||||
changed,user;
|
changed,user; [[Called when object changed due to user interaction]]
|
||||||
selection,changed;
|
selection,changed; [[Called when selection changed]]
|
||||||
selection,cleared;
|
selection,cleared; [[Called when selection was cleared]]
|
||||||
}
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
Loading…
Reference in New Issue