Latest rev (previous commit was out of date). Added README and NEWS.
[platform/upstream/atk.git] / atk / atkeditabletext.h
1 /* ATK -  Accessibility Toolkit
2  * Copyright 2001 Sun Microsystems Inc.
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Library General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Library General Public License for more details.
13  *
14  * You should have received a copy of the GNU Library General Public
15  * License along with this library; if not, write to the
16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17  * Boston, MA 02111-1307, USA.
18  */
19
20 #ifndef __ATK_EDITABLE_TEXT_H__
21 #define __ATK_EDITABLE_TEXT_H__
22
23 #include <pango/pango.h>
24 #include <atk/atkobject.h>
25
26 #ifdef __cplusplus
27 extern "C" {
28 #endif /* __cplusplus */
29
30 /*
31  * AtkEditableText is used to support access in an "accessibility" context
32  * to editing features of editable text widgets.
33  */
34
35 #define ATK_TYPE_EDITABLE_TEXT                    (atk_editable_text_get_type ())
36 #define ATK_IS_EDITABLE_TEXT(obj)                 G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_EDITABLE_TEXT)
37 #define ATK_EDITABLE_TEXT(obj)                    G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_EDITABLE_TEXT, AtkEditableText)
38 #define ATK_EDITABLE_TEXT_GET_IFACE(obj)          (G_TYPE_INSTANCE_GET_INTERFACE ((obj), ATK_TYPE_EDITABLE_TEXT, AtkEditableTextIface))
39
40 #ifndef _TYPEDEF_ATK_EDITABLE_TEXT_
41 #define _TYPEDEF_ATK_EDITABLE_TEXT_
42 typedef struct _AtkEditableText AtkEditableText;
43 #endif
44 typedef struct _AtkEditableTextIface AtkEditableTextIface;
45
46 struct _AtkEditableTextIface
47 {
48   GTypeInterface parent_interface;
49
50   void   (* select_text)          (AtkEditableText  *text,
51                                    gint             start_pos,
52                                    gint             end_pos);
53   void   (* set_attributes)       (AtkEditableText  *text,
54                                    gint             start_pos,
55                                    gint             end_pos,
56                                    PangoAttrList    *attributes);
57   void   (* set_text_contents)    (AtkEditableText  *text,
58                                    const gchar      *string);
59   void   (* insert_text)          (AtkEditableText  *text,
60                                    const gchar      *string,
61                                    gint             length,
62                                    gint             *position);
63   void   (* copy_text)            (AtkEditableText  *text,
64                                    gint             start_pos,
65                                    gint             end_pos);
66   void   (* cut_text)             (AtkEditableText  *text,
67                                    gint             start_pos,
68                                    gint             end_pos);
69   void   (* delete_text)          (AtkEditableText  *text,
70                                    gint             start_pos,
71                                    gint             end_pos);
72   void   (* paste_text)           (AtkEditableText  *text,
73                                    gint             position);
74 };
75 GType atk_editable_text_get_type (void);
76
77 void atk_editable_text_select_text          (AtkEditableText  *text,
78                                              gint             start_pos,
79                                              gint             end_pos);
80 void atk_editable_text_set_attributes       (AtkEditableText  *text,
81                                              gint             start_pos,
82                                              gint             end_pos,
83                                              PangoAttrList    *attributes);
84 void atk_editable_text_set_text_contents    (AtkEditableText  *text,
85                                              const gchar      *string);
86 void atk_editable_text_insert_text          (AtkEditableText  *text,
87                                              const gchar      *string,
88                                              gint             length,
89                                              gint             *position);
90 void atk_editable_text_copy_text            (AtkEditableText  *text,
91                                              gint             start_pos,
92                                              gint             end_pos);
93 void atk_editable_text_cut_text             (AtkEditableText  *text,
94                                              gint             start_pos,
95                                              gint             end_pos);
96 void atk_editable_text_delete_text          (AtkEditableText  *text,
97                                              gint             start_pos,
98                                              gint             end_pos);
99 void atk_editable_text_paste_text           (AtkEditableText  *text,
100                                              gint             position);
101  
102 #ifdef __cplusplus
103 }
104 #endif /* __cplusplus */
105
106
107 #endif /* __ATK_EDITABLE_TEXT_H__ */