## Documentation

Table of Contents
Class Inheritance Tree
Widget Screenshots
Package groups

1.     -----------------------------------------------------------------------

2.     --              GtkAda - Ada95 binding for Gtk+/Gnome                --

3.     --                                                                   --

4.     --                Copyright (C) 2001-2008, AdaCore                   --

5.     --                                                                   --

6.     -- This library is free software; you can redistribute it and/or     --

7.     -- modify it under the terms of the GNU General Public               --

8.     -- License as published by the Free Software Foundation; either      --

9.     -- version 2 of the License, or (at your option) any later version.  --

10.     --                                                                   --

11.     -- This library is distributed in the hope that it will be useful,   --

12.     -- but WITHOUT ANY WARRANTY; without even the implied warranty of    --

13.     -- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU --

14.     -- General Public License for more details.                          --

15.     --                                                                   --

16.     -- You should have received a copy of the GNU General Public         --

17.     -- License along with this library; if not, write to the             --

18.     -- Free Software Foundation, Inc., 59 Temple Place - Suite 330,      --

19.     -- Boston, MA 02111-1307, USA.                                       --

20.     --                                                                   --

21.     -- As a special exception, if other files instantiate generics from  --

22.     -- this unit, or you link this unit with other files to produce an   --

23.     -- executable, this  unit  does not  by itself cause  the resulting  --

24.     -- executable to be covered by the GNU General Public License. This  --

25.     -- exception does not however invalidate any other reasons why the   --

26.     -- executable file  might be covered by the  GNU Public License.     --

27.     -----------------------------------------------------------------------

29.     --  <description>

30.     --  This package defines the Gtk_Text_Attributes type.

31.     --  </description>

32.     --  <c_version>2.8.17</c_version>

33.     --  <group>Multiline Text Editor</group>

35.     with GlibTo API docTo specTo body;

36.     with Gdk.ColorTo API docTo specTo body;

37.     with Gtk.EnumsTo API docTo specTo body;

38.     with Pango.EnumsTo API docTo specTo body;

39.     with Pango.FontTo API docTo specTo body;

40.     with Pango.TabsTo API docTo specTo body;

42.     package Gtk.Text_AttributesTo API docTo specTo body is

44.        type Gtk_Text_Attributes is new Glib.C_ProxyTo API docTo spec;

45.        type Gtk_Text_Appearance is new Glib.C_ProxyTo API docTo spec;

47.        procedure Gtk_NewTo API docTo body (Text_Attr : out Gtk_Text_AttributesTo API docTo spec);

48.        --  Create a new Gtk_Text_Attributes structure.

50.        function Get_TypeTo API docTo body return Glib.GTypeTo API docTo spec;

51.        --  Return the internal type used fro a Gtk_Text_Attributes

53.        procedure RefTo API docTo body (Values : Gtk_Text_AttributesTo API docTo spec);

54.        --  Increase the reference counter of the given Gtk_Text_Attributes

55.        --  by one (this counter is initially set to 1 when this structure

56.        --  is created).

58.        procedure UnrefTo API docTo body (Values : Gtk_Text_AttributesTo API docTo spec);

59.        --  Decrease the reference counter by one. When it reaches zero,

60.        --  the Gtk_Text_Attributes is automatically deallocated.

62.        function CopyTo API docTo body (Src : Gtk_Text_AttributesTo API docTo spec) return Gtk_Text_AttributesTo API docTo spec;

63.        --  Create a copy of the given Gtk_Text_Attributes structure.

65.        procedure Copy_ValuesTo API docTo body

66.          (Src  : Gtk_Text_AttributesTo API docTo spec;

67.           Dest : Gtk_Text_AttributesTo API docTo spec);

68.        --  Copy the values from Src into Dest so that Dest has the same values

69.        --  as Src. Free existing values in Dest. Dest's reference counter

70.        --  is preserved.

72.        ---------------------

73.        -- Text appearance --

74.        ---------------------

76.        procedure Set_RiseTo API docTo body

77.          (Appearance : Gtk_Text_AppearanceTo API docTo spec;

78.           Rise       : GintTo API docTo spec);

79.        function Get_RiseTo API docTo body

80.          (Appearance : Gtk_Text_AppearanceTo API docTo spec) return GintTo API docTo spec;

81.        --  Offset of the text above the baseline (or below if negative)

83.        procedure Set_UnderlineTo API docTo body

84.          (Appearance : Gtk_Text_AppearanceTo API docTo spec;

85.           Underline  : Pango.Enums.UnderlineTo API docTo spec);

86.        function Get_UnderlineTo API docTo body

87.          (Appearance : Gtk_Text_AppearanceTo API docTo spec) return Pango.Enums.UnderlineTo API docTo spec;

88.        --  Set the underline mode

90.        procedure Set_StrikethroughTo API docTo body

91.          (Appearance : Gtk_Text_AppearanceTo API docTo spec;

92.           Strikethrough : Boolean);

93.        function Get_StrikethroughTo API docTo body

94.          (Appearance : Gtk_Text_AppearanceTo API docTo spec) return Boolean;

95.        --  Whether to strike through the text

97.        procedure Set_Fg_ColorTo API docTo body

98.          (Appearance : Gtk_Text_AppearanceTo API docTo spec;

99.           Color      : Gdk.Color.Gdk_ColorTo API docTo specTo body);

100.        function Get_Fg_ColorTo API docTo body

101.          (Appearance : Gtk_Text_AttributesTo API docTo spec) return Gdk.Color.Gdk_ColorTo API docTo specTo body;

102.        --  The color used to display the text

104.        procedure Set_Bg_ColorTo API docTo body

105.          (Appearance : Gtk_Text_AppearanceTo API docTo spec;

106.           Color      : Gdk.Color.Gdk_ColorTo API docTo specTo body);

107.        function Get_Bg_ColorTo API docTo body

108.          (Appearance : Gtk_Text_AttributesTo API docTo spec) return Gdk.Color.Gdk_ColorTo API docTo specTo body;

109.        --  The background color for the text

111.        procedure Set_Fg_StippleTo API docTo body

112.          (Appearance : Gtk_Text_AppearanceTo API docTo spec;

113.           Stipple    : Gdk.Gdk_BitmapTo API docTo spec);

114.        function Get_Fg_StippleTo API docTo body

115.          (Appearance : Gtk_Text_AttributesTo API docTo spec) return Gdk.Gdk_BitmapTo API docTo spec;

116.        --  The pattern used in the foreground

118.        procedure Set_Bg_StippleTo API docTo body

119.          (Appearance : Gtk_Text_AppearanceTo API docTo spec;

120.           Stipple    : Gdk.Gdk_BitmapTo API docTo spec);

121.        function Get_Bg_StippleTo API docTo body

122.          (Appearance : Gtk_Text_AttributesTo API docTo spec) return Gdk.Gdk_BitmapTo API docTo spec;

123.        --  The pattern used in the background

125.        ----------------

126.        -- Attributes --

127.        ----------------

129.        procedure Set_FontTo API docTo body

130.          (Text_Attr : Gtk_Text_AttributesTo API docTo spec;

131.           Font      : Pango.Font.Pango_Font_DescriptionTo API docTo spec);

132.        function Get_FontTo API docTo body (Text_Attr : Gtk_Text_AttributesTo API docTo spec)

133.          return Pango.Font.Pango_Font_DescriptionTo API docTo spec;

134.        --  Return the Pango_Font_Description associated to the given

135.        --  Gtk_Text_Attributes.

137.        procedure Set_JustificationTo API docTo body

138.          (Text_Attr : Gtk_Text_AttributesTo API docTo spec;

139.           Justification : Gtk.Enums.Gtk_JustificationTo API docTo spec);

140.        function Get_JustificationTo API docTo body

141.          (Text_Attr : Gtk_Text_AttributesTo API docTo spec) return Gtk.Enums.Gtk_JustificationTo API docTo spec;

142.        --  Set the justification for this attributes

144.        procedure Set_DirectionTo API docTo body

145.          (Text_Attr : Gtk_Text_AttributesTo API docTo spec;

146.           Direction : Gtk.Enums.Gtk_Text_DirectionTo API docTo spec);

147.        function Get_DirectionTo API docTo body

148.          (Text_Attr : Gtk_Text_AttributesTo API docTo spec) return Gtk.Enums.Gtk_Text_DirectionTo API docTo spec;

149.        --  Set the text direction for this attributes

151.        procedure Set_Font_ScaleTo API docTo body

152.          (Text_Attr : Gtk_Text_AttributesTo API docTo spec;

153.           Scale     : GdoubleTo API docTo spec);

154.        function Get_Font_ScaleTo API docTo body

155.          (Text_Attr : Gtk_Text_AttributesTo API docTo spec) return GdoubleTo API docTo spec;

156.        --  Set the scaling to use for the font

158.        procedure Set_Left_MarginTo API docTo body

159.          (Text_Attr : Gtk_Text_AttributesTo API docTo spec;

160.           Margin    : GintTo API docTo spec);

161.        function Get_Left_MarginTo API docTo body

162.          (Text_Attr : Gtk_Text_AttributesTo API docTo spec) return GintTo API docTo spec;

163.        --  Set the left margin

165.        procedure Set_Right_MarginTo API docTo body

166.          (Text_Attr : Gtk_Text_AttributesTo API docTo spec;

167.           Margin    : GintTo API docTo spec);

168.        function Get_Right_MarginTo API docTo body

169.          (Text_Attr : Gtk_Text_AttributesTo API docTo spec) return GintTo API docTo spec;

170.        --  Set the right margin

172.        procedure Set_IndentTo API docTo body

173.          (Text_Attr : Gtk_Text_AttributesTo API docTo spec;

174.           Margin    : GintTo API docTo spec);

175.        function Get_IndentTo API docTo body

176.          (Text_Attr : Gtk_Text_AttributesTo API docTo spec) return GintTo API docTo spec;

177.        --  Amount to indent the paragraph

179.        procedure Set_Pixels_Above_LineTo API docTo body

180.          (Text_Attr : Gtk_Text_AttributesTo API docTo spec;

181.           Margin    : GintTo API docTo spec);

182.        function Get_Pixels_Above_LineTo API docTo body

183.          (Text_Attr : Gtk_Text_AttributesTo API docTo spec) return GintTo API docTo spec;

184.        --  Set the number of blank pixels above paragraphs

186.        procedure Set_Pixels_Below_LineTo API docTo body

187.          (Text_Attr : Gtk_Text_AttributesTo API docTo spec;

188.           Margin    : GintTo API docTo spec);

189.        function Get_Pixels_Below_LineTo API docTo body

190.          (Text_Attr : Gtk_Text_AttributesTo API docTo spec) return GintTo API docTo spec;

191.        --  Set the number of blank pixels below paragraphs

193.        procedure Set_Pixels_Inside_WrapTo API docTo body

194.          (Text_Attr : Gtk_Text_AttributesTo API docTo spec;

195.           Margin    : GintTo API docTo spec);

196.        function Get_Pixels_Inside_WrapTo API docTo body

197.          (Text_Attr : Gtk_Text_AttributesTo API docTo spec) return GintTo API docTo spec;

198.        --  Set the number of pixels between wrapped lines in a paragraph

200.        procedure Set_Wrap_ModeTo API docTo body

201.          (Text_Attr : Gtk_Text_AttributesTo API docTo spec;

202.           Mode      : Gtk.Enums.Gtk_Wrap_ModeTo API docTo spec);

203.        function Get_Wrap_ModeTo API docTo body

204.          (Text_Attr : Gtk_Text_AttributesTo API docTo spec) return Gtk.Enums.Gtk_Wrap_ModeTo API docTo spec;

205.        --  Set the wrapping mode

207.        procedure Set_InvisibleTo API docTo body

208.          (Text_Attr : Gtk_Text_AttributesTo API docTo spec;

209.           Invisible : Boolean);

210.        function Get_InvisibleTo API docTo body (Text_Attr : Gtk_Text_AttributesTo API docTo spec) return Boolean;

211.        --  Whether the text is invisible

213.        procedure Set_Bg_Full_HeightTo API docTo body

214.          (Text_Attr : Gtk_Text_AttributesTo API docTo spec;

215.           Full_Height : Boolean);

216.        function Get_Bg_Full_HeightTo API docTo body

217.          (Text_Attr : Gtk_Text_AttributesTo API docTo spec) return Boolean;

218.        --  Whether the background occupies the full line height rather than just

219.        --  the area occupied by the text.

221.        procedure Set_EditableTo API docTo body

222.          (Text_Attr : Gtk_Text_AttributesTo API docTo spec;

223.           Editable  : Boolean);

224.        function Get_EditableTo API docTo body

225.          (Text_Attr : Gtk_Text_AttributesTo API docTo spec) return Boolean;

226.        --  Whether the text is editable

228.        procedure Set_TabsTo API docTo body

229.          (Text_Attr : Gtk_Text_AttributesTo API docTo spec;

230.           Tabs      : Pango.Tabs.Pango_Tab_ArrayTo API docTo spec);

231.        function Get_TabsTo API docTo body

232.          (Text_Attr : Gtk_Text_AttributesTo API docTo spec) return Pango.Tabs.Pango_Tab_ArrayTo API docTo spec;

233.        --  Set the default tab stops for paragraphs

235.        function Get_AppearanceTo API docTo body

236.          (Text_Attr : Gtk_Text_AttributesTo API docTo spec) return Gtk_Text_AppearanceTo API docTo spec;

237.        --  Return the appearance of the text. This can be modified with the

238.        --  subprograms above.

240.        ----------------

241.        -- Properties --

242.        ----------------

244.        --  <properties>

245.        --  The following properties are defined for this widget. See

246.        --  Glib.Properties for more information on properties.

247.        --

248.        --  </properties>

250.     private

251.        pragma Import (C, Get_TypeTo API docTo spec,    "gtk_text_attributes_get_type");

252.        pragma Import (C, RefTo API docTo spec,         "gtk_text_attributes_ref");

253.        pragma Import (C, UnrefTo API docTo spec,       "gtk_text_attributes_unref");

254.        pragma Import (C, CopyTo API docTo spec,        "gtk_text_attributes_copy");

255.        pragma Import (C, Copy_ValuesTo API docTo spec, "gtk_text_attributes_copy_values");

256.        pragma Import (C, Get_FontTo API docTo spec,    "ada_text_attributes_get_font");

257.        pragma Import (C, Set_FontTo API docTo spec,    "ada_text_attributes_set_font");

259.        pragma Import

260.          (C, Set_JustificationTo API docTo spec, "ada_text_attributes_set_justification");

261.        pragma Import

262.          (C, Get_JustificationTo API docTo spec, "ada_text_attributes_Get_justification");

263.        pragma Import (C, Set_DirectionTo API docTo spec, "ada_text_attributes_set_direction");

264.        pragma Import (C, Get_DirectionTo API docTo spec, "ada_text_attributes_get_direction");

265.        pragma Import

266.          (C, Set_Font_ScaleTo API docTo spec, "ada_text_attributes_set_font_scale");

267.        pragma Import

268.          (C, Get_Font_ScaleTo API docTo spec, "ada_text_attributes_get_font_scale");

269.        pragma Import (C, Set_RiseTo API docTo spec, "ada_text_appearance_set_rise");

270.        pragma Import (C, Get_RiseTo API docTo spec, "ada_text_appearance_get_rise");

271.        pragma Import (C, Set_UnderlineTo API docTo spec, "ada_text_appearance_set_underline");

272.        pragma Import (C, Get_UnderlineTo API docTo spec, "ada_text_appearance_get_underline");

273.        pragma Import (C, Set_Fg_ColorTo API docTo spec, "ada_text_appearance_set_fg_color");

274.        pragma Import (C, Get_Fg_ColorTo API docTo spec, "ada_text_appearance_get_fg_color");

275.        pragma Import (C, Set_Bg_ColorTo API docTo spec, "ada_text_appearance_set_bg_color");

276.        pragma Import (C, Get_Bg_ColorTo API docTo spec, "ada_text_appearance_get_bg_color");

277.        pragma Import (C, Set_Fg_StippleTo API docTo spec, "ada_text_appearance_set_fg_stipple");

278.        pragma Import (C, Get_Fg_StippleTo API docTo spec, "ada_text_appearance_get_fg_stipple");

279.        pragma Import (C, Set_Bg_StippleTo API docTo spec, "ada_text_appearance_set_bg_stipple");

280.        pragma Import (C, Get_Bg_StippleTo API docTo spec, "ada_text_appearance_get_bg_stipple");

282.        pragma Import (C, Set_Left_MarginTo API docTo spec, "ada_text_attribute_set_left_margin");

283.        pragma Import (C, Get_Left_MarginTo API docTo spec, "ada_text_attribute_get_left_margin");

284.        pragma Import (C, Set_Right_MarginTo API docTo spec, "ada_text_attribute_set_right_margin");

285.        pragma Import (C, Get_Right_MarginTo API docTo spec, "ada_text_attribute_get_right_margin");

286.        pragma Import (C, Set_IndentTo API docTo spec, "ada_text_attribute_set_indent");

287.        pragma Import (C, Get_IndentTo API docTo spec, "ada_text_attribute_get_indent");

288.        pragma Import

289.          (C, Set_Pixels_Above_LineTo API docTo spec, "ada_text_attribute_set_pixels_above_line");

290.        pragma Import

291.          (C, Get_Pixels_Above_LineTo API docTo spec, "ada_text_attribute_get_pixels_above_line");

292.        pragma Import

293.          (C, Set_Pixels_Below_LineTo API docTo spec, "ada_text_attribute_set_pixels_below_line");

294.        pragma Import

295.          (C, Get_Pixels_Below_LineTo API docTo spec, "ada_text_attribute_get_pixels_below_line");

296.        pragma Import

297.          (C, Set_Pixels_Inside_WrapTo API docTo spec, "ada_text_attribute_set_pixels_inside_wrap");

298.        pragma Import

299.          (C, Get_Pixels_Inside_WrapTo API docTo spec, "ada_text_attribute_get_pixels_inside_wrap");

300.        pragma Import (C, Set_Wrap_ModeTo API docTo spec, "ada_text_attribute_set_wrap_mode");

301.        pragma Import (C, Get_Wrap_ModeTo API docTo spec, "ada_text_attribute_get_wrap_mode");

302.        pragma Import (C, Get_AppearanceTo API docTo spec, "ada_text_attribute_get_appearance");

303.        pragma Import (C, Set_TabsTo API docTo spec, "ada_text_attribute_set_tabs");

304.        pragma Import (C, Get_TabsTo API docTo spec, "ada_text_attribute_get_tabs");

306.     end Gtk.Text_AttributesTo API docTo specTo body;

308.     --  This package doesn't give access to the "language" property of a

309.     --  Gtk_Text_Attributes