summaryrefslogtreecommitdiff
path: root/src/lib/elementary/efl_ui_textbox.eo
blob: 9cd5c520b539353b8523ca3d299ee5ece9e0ca66 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
enum @beta Efl.Ui.Textbox_Cnp_Content {
   [[What kind of content can be pasted into this widget using Copy & Paste or Drag & Drop functionality.

     Multiple options can be OR-ed together.
   ]]
   Nothing = 0, [[Nothing can be pasted or dropped into this widget.]]
   Text = 1,    [[Plain text can be pasted or dropped into this widget.]]
   Markup = 3,  [[Markup text can be pasted or dropped into this widget
                  (This includes Plain text).]]
   Image = 4,   [[Images can be pasted or dropped into this widget.]]
}

class Efl.Ui.Textbox extends Efl.Ui.Layout_Base implements Efl.Input.Clickable,
                 Efl.Access.Text, Efl.Access.Editable.Text, Efl.Ui.Scrollable
   composites
                 Efl.Text_Interactive, Efl.Text_Markup, Efl.Input_Text.Entity
{
   [[A flexible text widget which can be static (as a label) or editable by
     the user (as a text entry). It provides all sorts of editing facilities
     like automatic scrollbars, virtual keyboard, clipboard, configurable
     context menus or auto-capitalization, for example.
     @since 1.24]]
   methods {
      @property scrollable {
         [[Enable or disable scrolling in the widget.

           When scrolling is enabled scrollbars will appear if the text does
           not fit the widget size.

           Direct control of the scroll through the @Efl.Ui.Scrollable interface
           is only possible when this property is enabled.
         ]]
         set {}
         get {}
         values {
            scroll: bool(false); [[$true to enable scrolling.]]
         }
      }
      @property context_menu_enabled {
         [[This enables or disables the widget's contextual menu, typically
           accessible through a long-press or a right-button click.
         ]]
         set {
         }
         get {
         }
         values {
            enabled: bool; [[$true to enable the contextual menu.]]
         }
      }
      @property cnp_dnd_mode @beta {
         [[Controls the type of content which can be pasted into the widget.

           By default, both text and images are allowed..
         ]]
         set {
         }
         get {
         }
         values {
            allowed_formats : Efl.Ui.Textbox_Cnp_Content; [[Allowed content types.]]
         }
      }
      @property selection_handles_enabled {
         [[This enables or disables the visual handles around selected text,
           to allow simpler modification on touch screens.]]
         set {
         }
         get {
         }
         values {
            enabled: bool; [[$true to enable the selection handles.]]
         }
      }

      @property item_factory @beta {
         [[The factory that provides item in the text e.g.
           "emoticon/happy" or "href=file://image.jpg" etc.
         ]]
         values {
            item_factory: Efl.Canvas.Textblock_Factory; [[Factory to create items]]
         }
      }
      cursor_create {
         [[Creates and returns a new cursor for the text.]]
         return: Efl.Text_Cursor.Object @move; [[Text cursor.]]
      }
      selection_copy {
         [[This executes a "copy" action on the selected text in the widget.]]
      }
      selection_paste {
         [[This executes a "paste" action in the widget.]]
      }
      selection_cut {
         [[This executes a "cut" action on the selected text in the widget.]]
      }
   }
   implements {
      Efl.Object.constructor;
      Efl.Object.finalize;
      Efl.Object.destructor;
      Efl.Gfx.Entity.visible { set; }
      Efl.Gfx.Entity.position { set; }
      Efl.Gfx.Entity.size { set; }
      Efl.Canvas.Group.group_member_add;
      Efl.Canvas.Group.group_calculate;
      Efl.Ui.Widget.on_access_activate;
      Efl.Ui.Widget.theme_apply;
      Efl.Ui.Widget.widget_input_event_handler;
      Efl.Ui.Focus.Object.on_focus_update;
      Efl.Ui.Widget.interest_region { get; }
      Efl.Ui.Widget.disabled {set;}
      Efl.Text_Format.password {set;}
      Efl.Text_Format.multiline {set;}
      Efl.Access.Object.state_set { get; }
      Efl.Access.Object.i18n_name { get; }
      Efl.Access.Text.access_text { get; }
      Efl.Access.Text.string { get; }
      Efl.Access.Text.attribute { get; }
      Efl.Access.Text.text_attributes { get; }
      Efl.Access.Text.default_attributes { get; }
      Efl.Access.Text.caret_offset { get; set; }
      Efl.Access.Text.character { get; }
      Efl.Access.Text.character_extents { get; }
      Efl.Access.Text.character_count { get; }
      Efl.Access.Text.offset_at_point { get; }
      Efl.Access.Text.bounded_ranges { get; }
      Efl.Access.Text.range_extents { get; }
      Efl.Access.Text.access_selection { get; set; }
      Efl.Access.Text.selections_count { get; }
      Efl.Access.Text.selection_add;
      Efl.Access.Text.selection_remove;
      Efl.Access.Editable.Text.text_content { set; }
      Efl.Access.Editable.Text.insert;
      Efl.Access.Editable.Text.copy;
      Efl.Access.Editable.Text.cut;
      Efl.Access.Editable.Text.delete;
      Efl.Access.Editable.Text.paste;
      Efl.Text_Interactive.editable { set; }
      Efl.Part.part_get;
      Efl.Ui.Scrollable.content_pos { set; get; }
      Efl.Ui.Scrollable.content_size{ get; }
      Efl.Ui.Scrollable.viewport_geometry{ get; }
      Efl.Ui.Scrollable.bounce_enabled { set; get; }
      Efl.Ui.Scrollable.scroll_freeze { get; set; }
      Efl.Ui.Scrollable.scroll_hold { get; set; }
      Efl.Ui.Scrollable.looping { get; set; }
      Efl.Ui.Scrollable.movement_block { get; set; }
      Efl.Ui.Scrollable.gravity { get; set; }
      Efl.Ui.Scrollable.match_content { set; }
      Efl.Ui.Scrollable.step_size { set; get; }
      Efl.Ui.Scrollable.scroll;
   }
   events {
      selection,paste: void; [[Called when selection is pasted.]]
      selection,copy: void; [[Called when selection is copied.]]
      selection,cut: void; [[Called when selection is cut.]]
      changed: void; [[Called when entry changes]]
      context,open: void; [[Called when context menu was opened]]
   }
}