1. Compilation Units

    1. Cairo
    2. Cairo.Font_Face
    3. Cairo.Font_Options
    4. Cairo.Image_Surface
    5. Cairo.PDF
    6. Cairo.Matrix
    7. Cairo.Pattern
    8. Cairo.Png
    9. Cairo.SVG
    10. Cairo.Region
    11. Cairo.Scaled_Font
    12. Cairo.Surface
    13. Fontconfig
    14. Gdk
    15. Gdk.Cairo
    16. Gdk.Color
    17. Gdk.Cursor
    18. Gdk.Device
    19. Gdk.Device_Manager
    20. Gdk.Device_Tool
    21. Gdk.Display
    22. Gdk.Display_Manager
    23. Gdk.Dnd
    24. Gdk.Drag_Contexts
    25. Gdk.Drawing_Context
    26. Gdk.Event
      1. Gdk.Event.Handler_Set_User_Data
    27. Gdk.Frame_Clock
    28. Gdk.Frame_Timings
    29. Gdk.GLContext
    30. Gdk.Input
      1. Gdk.Input.Input_Add
    31. Gdk.Keyval
    32. Gdk.Main
    33. Gdk.Monitor
    34. Gdk.Pixbuf
    35. Gdk.RGBA
    36. Gdk.Property
    37. Gdk.Rectangle
    38. Gdk.Screen
    39. Gdk.Seat
    40. Gdk.Threads
    41. Gdk.Types
    42. Gdk.Types.Keysyms
    43. Gdk.Visual
    44. Gdk.Window
      1. Gdk.Window.Invalidate_Maybe_Recurse_User_Data
    45. Gdk.Window_Attr
    46. Glib
    47. Glib.Action
    48. Glib.Action_Group
    49. Glib.Action_Map
    50. Glib.Application
    51. Glib.Cancellable
      1. Glib.Cancellable.Connect_User_Data
    52. Glib.Convert
    53. Glib.Enums
    54. Glib.GSlist
      1. Glib.GSlist.Generic_SList
    55. Glib.Error
    56. Glib.G_Icon
    57. Glib.Generic_Properties
      1. Glib.Generic_Properties.Generic_Enumeration_Property
      2. Glib.Generic_Properties.Generic_Internal_Boxed_Property
      3. Glib.Generic_Properties.Generic_Internal_Discrete_Property
    58. Glib.Glist
      1. Glib.Glist.Generic_List
    59. Glib.Gnodes
      1. Glib.Gnodes.Gnode_Data
    60. Glib.Graphs
    61. Glib.Graphs.Layouts
      1. Glib.Graphs.Layouts.Layered_Layouts
    62. Glib.IOChannel
    63. Glib.Key_File
    64. Glib.List_Model
    65. Glib.Main
      1. Glib.Main.Generic_Sources
    66. Glib.Menu
    67. Glib.Menu_Model
    68. Glib.Messages
    69. Glib.Module
    70. Glib.Notification
    71. Glib.Object
      1. Glib.Object.User_Data
      2. Glib.Object.User_Data_Closure
    72. Glib.Option
      1. Glib.Option.Set_Translate_Func_User_Data
    73. Glib.Poll
    74. Glib.Properties
    75. Glib.Properties.Creation
    76. Glib.Simple_Action
    77. Glib.Simple_Action_Group
    78. Glib.Spawn
    79. Glib.String
    80. Glib.Type_Conversion_Hooks
      1. Glib.Type_Conversion_Hooks.Hook_Registrator
    81. Glib.Types
      1. Glib.Types.Implements
    82. Glib.Unicode
    83. Glib.Utils
    84. Glib.Values
    85. Glib.Variant
    86. Glib.XML
    87. Gtk
    88. Gtk.About_Dialog
    89. Gtk.Accel_Group
    90. Gtk.Accel_Label
    91. Gtk.Accel_Map
      1. Gtk.Accel_Map.Foreach_Unfiltered_User_Data
      2. Gtk.Accel_Map.Foreach_User_Data
    92. Gtk.Action
    93. Gtk.Action_Bar
    94. Gtk.Action_Group
      1. Gtk.Action_Group.Set_Translate_Func_User_Data
    95. Gtk.Actionable
    96. Gtk.Activatable
    97. Gtk.Adjustment
    98. Gtk.Alignment
    99. Gtk.Application
    100. Gtk.Application_Window
    101. Gtk.Arguments
    102. Gtk.Arrow
    103. Gtk.Aspect_Frame
    104. Gtk.Assistant
      1. Gtk.Assistant.Set_Forward_Page_Func_User_Data
    105. Gtk.Bin
    106. Gtk.Binding_Set
    107. Gtk.Bindings
    108. Gtk.Box
    109. Gtk.Buildable
    110. Gtk.Builder
    111. Gtk.Button
    112. Gtk.Button_Box
    113. Gtk.Calendar
      1. Gtk.Calendar.Set_Detail_Func_User_Data
    114. Gtk.Cell_Area
      1. Gtk.Cell_Area.Foreach_Alloc_User_Data
      2. Gtk.Cell_Area.Foreach_User_Data
      3. Gtk.Cell_Area.Set_Cell_Data_Func_User_Data
    115. Gtk.Cell_Area_Box
      1. Gtk.Cell_Area_Box.Set_Cell_Data_Func_User_Data
    116. Gtk.Cell_Area_Context
    117. Gtk.Cell_Editable
    118. Gtk.Cell_Layout
      1. Gtk.Cell_Layout.Set_Cell_Data_Func_User_Data
    119. Gtk.Cell_Renderer
    120. Gtk.Cell_Renderer_Accel
    121. Gtk.Cell_Renderer_Combo
    122. Gtk.Cell_Renderer_Pixbuf
    123. Gtk.Cell_Renderer_Progress
    124. Gtk.Cell_Renderer_Spin
    125. Gtk.Cell_Renderer_Spinner
    126. Gtk.Cell_Renderer_Text
    127. Gtk.Cell_Renderer_Toggle
    128. Gtk.Cell_View
      1. Gtk.Cell_View.Set_Cell_Data_Func_User_Data
    129. Gtk.Check_Button
    130. Gtk.Check_Menu_Item
    131. Gtk.Clipboard
    132. Gtk.Color_Button
    133. Gtk.Color_Chooser
    134. Gtk.Color_Chooser_Dialog
    135. Gtk.Color_Chooser_Widget
    136. Gtk.Color_Selection
    137. Gtk.Color_Selection_Dialog
    138. Gtk.Combo_Box
      1. Gtk.Combo_Box.Set_Cell_Data_Func_User_Data
      2. Gtk.Combo_Box.Set_Row_Separator_Func_User_Data
    139. Gtk.Combo_Box_Text
      1. Gtk.Combo_Box_Text.Set_Cell_Data_Func_User_Data
    140. Gtk.Container
      1. Gtk.Container.Forall_User_Data
      2. Gtk.Container.Foreach_User_Data
    141. Gtk.Css_Provider
    142. Gtk.Css_Section
    143. Gtk.Dialog
    144. Gtk.Dnd
    145. Gtk.Drawing_Area
    146. Gtk.Editable
    147. Gtk.Entry_Buffer
    148. Gtk.Entry_Completion
      1. Gtk.Entry_Completion.Set_Cell_Data_Func_User_Data
      2. Gtk.Entry_Completion.Set_Match_Func_User_Data
    149. Gtk.Enums
    150. Gtk.Event_Box
    151. Gtk.Event_Controller
    152. Gtk.Expander
    153. Gtk.File_Chooser
    154. Gtk.File_Chooser_Button
    155. Gtk.File_Chooser_Dialog
    156. Gtk.File_Chooser_Widget
    157. Gtk.File_Filter
      1. Gtk.File_Filter.Add_Custom_User_Data
    158. Gtk.Fixed
    159. Gtk.Flow_Box
      1. Gtk.Flow_Box.Bind_Model_User_Data
      2. Gtk.Flow_Box.Selected_Foreach_User_Data
      3. Gtk.Flow_Box.Set_Filter_Func_User_Data
      4. Gtk.Flow_Box.Set_Sort_Func_User_Data
    160. Gtk.Flow_Box_Child
    161. Gtk.Font_Button
      1. Gtk.Font_Button.Set_Filter_Func_User_Data
    162. Gtk.Font_Chooser
      1. Gtk.Font_Chooser.Set_Filter_Func_User_Data
    163. Gtk.Font_Chooser_Dialog
      1. Gtk.Font_Chooser_Dialog.Set_Filter_Func_User_Data
    164. Gtk.Font_Chooser_Widget
      1. Gtk.Font_Chooser_Widget.Set_Filter_Func_User_Data
    165. Gtk.Font_Selection
    166. Gtk.Font_Selection_Dialog
    167. Gtk.Frame
    168. Gtk.GLArea
    169. Gtk.GRange
    170. Gtk.GEntry
    171. Gtk.Gesture
    172. Gtk.Gesture_Drag
    173. Gtk.Gesture_Long_Press
    174. Gtk.Gesture_Multi_Press
    175. Gtk.Gesture_Pan
    176. Gtk.Gesture_Rotate
    177. Gtk.Gesture_Single
    178. Gtk.Gesture_Swipe
    179. Gtk.Gesture_Zoom
    180. Gtk.Gradient
    181. Gtk.Grid
    182. Gtk.Handle_Box
    183. Gtk.Hbutton_Box
    184. Gtk.Header_Bar
    185. Gtk.IM_Context
    186. Gtk.IM_Context_Simple
    187. Gtk.IM_Multi_Context
    188. Gtk.Hsv
    189. Gtk.Icon_Factory
    190. Gtk.Icon_Set
    191. Gtk.Icon_Source
    192. Gtk.Icon_Theme
    193. Gtk.Icon_View
      1. Gtk.Icon_View.Selected_Foreach_User_Data
      2. Gtk.Icon_View.Set_Cell_Data_Func_User_Data
    194. Gtk.Image
    195. Gtk.Image_Menu_Item
    196. Gtk.Info_Bar
    197. Gtk.Invisible
    198. Gtk.Label
    199. Gtk.Layout
    200. Gtk.Level_Bar
    201. Gtk.Link_Button
    202. Gtk.List_Box
      1. Gtk.List_Box.Bind_Model_User_Data
      2. Gtk.List_Box.Selected_Foreach_User_Data
      3. Gtk.List_Box.Set_Filter_Func_User_Data
      4. Gtk.List_Box.Set_Header_Func_User_Data
      5. Gtk.List_Box.Set_Sort_Func_User_Data
    203. Gtk.List_Box_Row
    204. Gtk.List_Store
      1. Gtk.List_Store.Foreach_User_Data
      2. Gtk.List_Store.Set_Default_Sort_Func_User_Data
      3. Gtk.List_Store.Set_Sort_Func_User_Data
    205. Gtk.Main
    206. Gtk.Menu
      1. Gtk.Menu.Popup_For_Device_User_Data
      2. Gtk.Menu.Popup_User_Data
    207. Gtk.Menu_Bar
    208. Gtk.Menu_Button
    209. Gtk.Menu_Item
    210. Gtk.Menu_Shell
    211. Gtk.Menu_Tool_Button
    212. Gtk.Message_Dialog
    213. Gtk.Misc
    214. Gtk.Notebook
    215. Gtk.Offscreen_Window
    216. Gtk.Orientable
    217. Gtk.Overlay
    218. Gtk.Page_Setup
    219. Gtk.Paned
    220. Gtk.Paper_Size
    221. Gtk.Popover
    222. Gtk.Print_Context
    223. Gtk.Print_Operation
    224. Gtk.Print_Operation_Preview
    225. Gtk.Print_Settings
      1. Gtk.Print_Settings.Foreach_User_Data
    226. Gtk.Progress_Bar
    227. Gtk.Radio_Action
    228. Gtk.Radio_Button
    229. Gtk.Radio_Menu_Item
    230. Gtk.Radio_Tool_Button
    231. Gtk.Rc
    232. Gtk.Recent_Action
      1. Gtk.Recent_Action.Set_Sort_Func_User_Data
    233. Gtk.Recent_Chooser
      1. Gtk.Recent_Chooser.Set_Sort_Func_User_Data
    234. Gtk.Recent_Chooser_Dialog
      1. Gtk.Recent_Chooser_Dialog.Set_Sort_Func_User_Data
    235. Gtk.Recent_Chooser_Menu
      1. Gtk.Recent_Chooser_Menu.Set_Sort_Func_User_Data
    236. Gtk.Recent_Chooser_Widget
      1. Gtk.Recent_Chooser_Widget.Set_Sort_Func_User_Data
    237. Gtk.Recent_Filter
      1. Gtk.Recent_Filter.Add_Custom_User_Data
    238. Gtk.Recent_Info
    239. Gtk.Recent_Manager
    240. Gtk.Revealer
    241. Gtk.Scale
    242. Gtk.Scale_Button
    243. Gtk.Scrollable
    244. Gtk.Scrollbar
    245. Gtk.Scrolled_Window
    246. Gtk.Search_Bar
    247. Gtk.Search_Entry
    248. Gtk.Selection_Data
    249. Gtk.Separator
    250. Gtk.Separator_Menu_Item
    251. Gtk.Separator_Tool_Item
    252. Gtk.Settings
    253. Gtk.Shortcuts_Window
    254. Gtk.Size_Group
    255. Gtk.Spin_Button
    256. Gtk.Spinner
    257. Gtk.Stack
    258. Gtk.Stack_Switcher
    259. Gtk.Status_Bar
    260. Gtk.Status_Icon
    261. Gtk.Stock
    262. Gtk.Style
    263. Gtk.Style_Context
    264. Gtk.Style_Properties
    265. Gtk.Style_Provider
    266. Gtk.Switch
    267. Gtk.Symbolic_Color
    268. Gtk.Table
    269. Gtk.Target_Entry
    270. Gtk.Target_List
    271. Gtk.Tearoff_Menu_Item
    272. Gtk.Text_Attributes
    273. Gtk.Text_Buffer
    274. Gtk.Text_Child
    275. Gtk.Text_Child_Anchor
    276. Gtk.Text_Iter
    277. Gtk.Text_Mark
    278. Gtk.Text_Tag
    279. Gtk.Text_Tag_Table
      1. Gtk.Text_Tag_Table.Foreach_User_Data
    280. Gtk.Text_View
    281. Gtk.Theming_Engine
    282. Gtk.Toggle_Action
    283. Gtk.Toggle_Button
    284. Gtk.Toggle_Tool_Button
    285. Gtk.Tool_Button
    286. Gtk.Tool_Item
    287. Gtk.Tool_Item_Group
    288. Gtk.Tool_Palette
    289. Gtk.Tool_Shell
    290. Gtk.Toolbar
    291. Gtk.Tooltip
    292. Gtk.Tree_Drag_Dest
    293. Gtk.Tree_Drag_Source
    294. Gtk.Tree_Model
      1. Gtk.Tree_Model.Foreach_User_Data
    295. Gtk.Tree_Model.Utils
    296. Gtk.Tree_Model_Filter
      1. Gtk.Tree_Model_Filter.Foreach_User_Data
      2. Gtk.Tree_Model_Filter.Set_Modify_Func_User_Data
      3. Gtk.Tree_Model_Filter.Set_Visible_Func_User_Data
    297. Gtk.Tree_Model_Sort
      1. Gtk.Tree_Model_Sort.Foreach_User_Data
      2. Gtk.Tree_Model_Sort.Set_Default_Sort_Func_User_Data
      3. Gtk.Tree_Model_Sort.Set_Sort_Func_User_Data
    298. Gtk.Tree_Row_Reference
    299. Gtk.Tree_Selection
      1. Gtk.Tree_Selection.Selected_Foreach_User_Data
      2. Gtk.Tree_Selection.Set_Select_Function_User_Data
    300. Gtk.Tree_Sortable
      1. Gtk.Tree_Sortable.Set_Default_Sort_Func_User_Data
      2. Gtk.Tree_Sortable.Set_Sort_Func_User_Data
    301. Gtk.Tree_Store
      1. Gtk.Tree_Store.Foreach_User_Data
      2. Gtk.Tree_Store.Generic_Set
      3. Gtk.Tree_Store.Set_Default_Sort_Func_User_Data
      4. Gtk.Tree_Store.Set_Sort_Func_User_Data
    302. Gtk.Tree_View
      1. Gtk.Tree_View.Insert_Column_With_Data_Func_User_Data
      2. Gtk.Tree_View.Map_Expanded_Rows_User_Data
      3. Gtk.Tree_View.Set_Column_Drag_Function_User_Data
      4. Gtk.Tree_View.Set_Destroy_Count_Func_User_Data
      5. Gtk.Tree_View.Set_Row_Separator_Func_User_Data
      6. Gtk.Tree_View.Set_Search_Equal_Func_User_Data
      7. Gtk.Tree_View.Set_Search_Position_Func_User_Data
    303. Gtk.Tree_View_Column
      1. Gtk.Tree_View_Column.Set_Cell_Data_Func_User_Data
    304. Gtk.Type_Conversion
    305. Gtk.UI_Manager
    306. Gtk.Vbutton_Box
    307. Gtk.Viewport
    308. Gtk.Volume_Button
    309. Gtk.Widget
      1. Gtk.Widget.Add_Tick_Callback_User_Data
      2. Gtk.Widget.Set_Connect_Func_User_Data
    310. Gtk.Window
    311. Gtkada
    312. Gtkada.Abstract_List_Model
    313. Gtkada.Abstract_Tree_Model
    314. Gtkada.Application
    315. Gtkada.Bindings
    316. Gtkada.Builder
    317. Gtkada.C
      1. Gtkada.C.Unbounded_Arrays
    318. Gtkada.Canvas
    319. Gtkada.Canvas_View
    320. Gtkada.Canvas_View.Astar
    321. Gtkada.Canvas_View.Links
    322. Gtkada.Canvas_View.Models
      1. Gtkada.Canvas_View.Models.Rtree_Models
    323. Gtkada.Canvas_View.Models.Layers
    324. Gtkada.Canvas_View.Objects
    325. Gtkada.Canvas_View.Rtrees
    326. Gtkada.Canvas_View.Views
    327. Gtkada.Dialogs
    328. Gtkada.File_Selection
    329. Gtkada.Handlers
    330. Gtkada.Intl
    331. Gtkada.MDI
      1. Gtkada.MDI.Desktop
    332. Gtkada.Multi_Paned
    333. Gtkada.Multiline_Entry
    334. Gtkada.Pixmaps
    335. Gtkada.Printing
    336. Gtkada.Stock_Icons
    337. Gtkada.Stock_Labels
    338. Gtkada.Style
    339. Gtkada.Types
    340. Pango
    341. Pango.Attributes
    342. Pango.Cairo
    343. Pango.Context
    344. Pango.Coverage
    345. Pango.Enums
    346. Pango.Font
    347. Pango.Font_Face
    348. Pango.Font_Family
    349. Pango.Font_Map
    350. Pango.Font_Metrics
    351. Pango.Fontset
      1. Pango.Fontset.Foreach_User_Data
    352. Pango.Language
    353. Pango.Layout
    354. Pango.Matrix
    355. Pango.Tabs
  2. Tagged Types

    1. Gdk.Device.Gdk_Device_Record
    2. Gdk.Device_Manager.Gdk_Device_Manager_Record
    3. Gdk.Device_Tool.Gdk_Device_Tool_Record
    4. Gdk.Display.Gdk_Display_Record
    5. Gdk.Drag_Contexts.Drag_Context_Record
    6. Gdk.Drawing_Context.Gdk_Drawing_Context_Record
    7. Gdk.Frame_Clock.Gdk_Frame_Clock_Record
    8. Gdk.Frame_Timings.Gdk_Frame_Timings
    9. Gdk.GLContext.Gdk_GLContext_Record
    10. Gdk.Monitor.Gdk_Monitor_Record
    11. Gdk.Pixbuf.Gdk_Pixbuf_Record
    12. Gdk.Screen.Gdk_Screen_Record
    13. Glib.Application.Gapplication_Command_Line_Record
    14. Glib.Application.Gapplication_Record
    15. Gdk.Seat.Gdk_Seat_Record
    16. Glib.C_Boxed
    17. Glib.Cancellable.Gcancellable_Record
    18. Glib.Graphs.Layouts.Base_Dummy_Vertex
    19. Glib.Graphs.Edge
    20. Glib.Graphs.Vertex
    21. Glib.Menu.Gmenu_Item_Record
    22. Glib.Menu.Gmenu_Record
    23. Glib.Menu_Model.Gmenu_Attribute_Iter_Record
    24. Glib.Menu_Model.Gmenu_Link_Iter_Record
    25. Glib.Menu_Model.Gmenu_Model_Record
    26. Glib.Object.GObject_Record
    27. Glib.Notification.Gnotification_Record
    28. Glib.Object.G_Binding_Record
    29. Glib.Option.Goption_Context
    30. Glib.Simple_Action.Gsimple_Action_Record
    31. Glib.Simple_Action_Group.Gsimple_Action_Group_Record
    32. Glib.Variant.Gvariant
    33. Gtk.About_Dialog.Gtk_About_Dialog_Record
    34. Gtk.Accel_Group.Gtk_Accel_Group_Record
    35. Gtk.Accel_Label.Gtk_Accel_Label_Record
    36. Gtk.Accel_Map.Gtk_Accel_Map_Record
    37. Gtk.Action.Gtk_Action_Record
    38. Gtk.Action_Bar.Gtk_Action_Bar_Record
    39. Gtk.Action_Group.Gtk_Action_Group_Record
    40. Gtk.Adjustment.Gtk_Adjustment_Record
    41. Gtk.Alignment.Gtk_Alignment_Record
    42. Gtk.Application.Gtk_Application_Record
    43. Gtk.Application_Window.Gtk_Application_Window_Record
    44. Gtk.Arrow.Gtk_Arrow_Record
    45. Gtk.Aspect_Frame.Gtk_Aspect_Frame_Record
    46. Gtk.Assistant.Gtk_Assistant_Record
    47. Gtk.Bin.Gtk_Bin_Record
    48. Gtk.Box.Gtk_Box_Record
    49. Gtk.Builder.Gtk_Builder_Record
    50. Gtk.Button.Gtk_Button_Record
    51. Gtk.Button_Box.Gtk_Button_Box_Record
    52. Gtk.Calendar.Gtk_Calendar_Record
    53. Gtk.Cell_Area.Gtk_Cell_Area_Record
    54. Gtk.Cell_Area_Box.Gtk_Cell_Area_Box_Record
    55. Gtk.Cell_Area_Context.Gtk_Cell_Area_Context_Record
    56. Gtk.Cell_Renderer.Gtk_Cell_Renderer_Record
    57. Gtk.Cell_Renderer_Accel.Gtk_Cell_Renderer_Accel_Record
    58. Gtk.Cell_Renderer_Combo.Gtk_Cell_Renderer_Combo_Record
    59. Gtk.Cell_Renderer_Pixbuf.Gtk_Cell_Renderer_Pixbuf_Record
    60. Gtk.Cell_Renderer_Progress.Gtk_Cell_Renderer_Progress_Record
    61. Gtk.Cell_Renderer_Spin.Gtk_Cell_Renderer_Spin_Record
    62. Gtk.Cell_Renderer_Spinner.Gtk_Cell_Renderer_Spinner_Record
    63. Gtk.Cell_Renderer_Text.Gtk_Cell_Renderer_Text_Record
    64. Gtk.Cell_Renderer_Toggle.Gtk_Cell_Renderer_Toggle_Record
    65. Gtk.Cell_View.Gtk_Cell_View_Record
    66. Gtk.Check_Button.Gtk_Check_Button_Record
    67. Gtk.Check_Menu_Item.Gtk_Check_Menu_Item_Record
    68. Gtk.Clipboard.Gtk_Clipboard_Record
    69. Gtk.Color_Button.Gtk_Color_Button_Record
    70. Gtk.Color_Chooser_Dialog.Gtk_Color_Chooser_Dialog_Record
    71. Gtk.Color_Chooser_Widget.Gtk_Color_Chooser_Widget_Record
    72. Gtk.Color_Selection.Gtk_Color_Selection_Record
    73. Gtk.Color_Selection_Dialog.Gtk_Color_Selection_Dialog_Record
    74. Gtk.Combo_Box.Gtk_Combo_Box_Record
    75. Gtk.Combo_Box_Text.Gtk_Combo_Box_Text_Record
    76. Gtk.Container.Gtk_Container_Record
    77. Gtk.Css_Provider.Gtk_Css_Provider_Record
    78. Gtk.Css_Section.Gtk_Css_Section
    79. Gtk.Dialog.Gtk_Dialog_Record
    80. Gtk.Drawing_Area.Gtk_Drawing_Area_Record
    81. Gtk.Entry_Buffer.Gtk_Entry_Buffer_Record
    82. Gtk.Entry_Completion.Gtk_Entry_Completion_Record
    83. Gtk.Event_Box.Gtk_Event_Box_Record
    84. Gtk.Event_Controller.Gtk_Event_Controller_Record
    85. Gtk.Expander.Gtk_Expander_Record
    86. Gtk.File_Chooser_Button.Gtk_File_Chooser_Button_Record
    87. Gtk.File_Chooser_Dialog.Gtk_File_Chooser_Dialog_Record
    88. Gtk.File_Chooser_Widget.Gtk_File_Chooser_Widget_Record
    89. Gtk.File_Filter.Gtk_File_Filter_Record
    90. Gtk.Fixed.Gtk_Fixed_Record
    91. Gtk.Flow_Box.Gtk_Flow_Box_Record
    92. Gtk.Flow_Box_Child.Gtk_Flow_Box_Child_Record
    93. Gtk.Font_Button.Gtk_Font_Button_Record
    94. Gtk.Font_Chooser_Dialog.Gtk_Font_Chooser_Dialog_Record
    95. Gtk.Font_Chooser_Widget.Gtk_Font_Chooser_Widget_Record
    96. Gtk.Font_Selection.Gtk_Font_Selection_Record
    97. Gtk.Font_Selection_Dialog.Gtk_Font_Selection_Dialog_Record
    98. Gtk.Frame.Gtk_Frame_Record
    99. Gtk.GLArea.Gtk_GLArea_Record
    100. Gtk.GRange.Gtk_Range_Record
    101. Gtk.GEntry.Gtk_Entry_Record
    102. Gtk.Gesture.Gtk_Gesture_Record
    103. Gtk.Gesture_Drag.Gtk_Gesture_Drag_Record
    104. Gtk.Gesture_Long_Press.Gtk_Gesture_Long_Press_Record
    105. Gtk.Gesture_Multi_Press.Gtk_Gesture_Multi_Press_Record
    106. Gtk.Gesture_Pan.Gtk_Gesture_Pan_Record
    107. Gtk.Gesture_Rotate.Gtk_Gesture_Rotate_Record
    108. Gtk.Gesture_Single.Gtk_Gesture_Single_Record
    109. Gtk.Gesture_Swipe.Gtk_Gesture_Swipe_Record
    110. Gtk.Gesture_Zoom.Gtk_Gesture_Zoom_Record
    111. Gtk.Gradient.Gtk_Gradient
    112. Gtk.Grid.Gtk_Grid_Record
    113. Gtk.Handle_Box.Gtk_Handle_Box_Record
    114. Gtk.Hbutton_Box.Gtk_Hbutton_Box_Record
    115. Gtk.Header_Bar.Gtk_Header_Bar_Record
    116. Gtk.IM_Context.Gtk_IM_Context_Record
    117. Gtk.IM_Context_Simple.Gtk_IM_Context_Simple_Record
    118. Gtk.IM_Multi_Context.Gtk_IM_Multi_Context_Record
    119. Gtk.Hsv.Gtk_Hsv_Record
    120. Gtk.Icon_Factory.Gtk_Icon_Factory_Record
    121. Gtk.Icon_Set.Gtk_Icon_Set
    122. Gtk.Icon_Source.Gtk_Icon_Source
    123. Gtk.Icon_Theme.Gtk_Icon_Info_Record
    124. Gtk.Icon_Theme.Gtk_Icon_Theme_Record
    125. Gtk.Icon_View.Gtk_Icon_View_Record
    126. Gtk.Image.Gtk_Image_Record
    127. Gtk.Image_Menu_Item.Gtk_Image_Menu_Item_Record
    128. Gtk.Info_Bar.Gtk_Info_Bar_Record
    129. Gtk.Invisible.Gtk_Invisible_Record
    130. Gtk.Label.Gtk_Label_Record
    131. Gtk.Layout.Gtk_Layout_Record
    132. Gtk.Level_Bar.Gtk_Level_Bar_Record
    133. Gtk.Link_Button.Gtk_Link_Button_Record
    134. Gtk.List_Box.Gtk_List_Box_Record
    135. Gtk.List_Box_Row.Gtk_List_Box_Row_Record
    136. Gtk.List_Store.Gtk_List_Store_Record
    137. Gtk.Menu.Gtk_Menu_Record
    138. Gtk.Menu_Bar.Gtk_Menu_Bar_Record
    139. Gtk.Menu_Button.Gtk_Menu_Button_Record
    140. Gtk.Menu_Item.Gtk_Menu_Item_Record
    141. Gtk.Menu_Shell.Gtk_Menu_Shell_Record
    142. Gtk.Menu_Tool_Button.Gtk_Menu_Tool_Button_Record
    143. Gtk.Message_Dialog.Gtk_Message_Dialog_Record
    144. Gtk.Misc.Gtk_Misc_Record
    145. Gtk.Notebook.Gtk_Notebook_Record
    146. Gtk.Offscreen_Window.Gtk_Offscreen_Window_Record
    147. Gtk.Overlay.Gtk_Overlay_Record
    148. Gtk.Page_Setup.Gtk_Page_Setup_Record
    149. Gtk.Paned.Gtk_Paned_Record
    150. Gtk.Paper_Size.Gtk_Paper_Size
    151. Gtk.Popover.Gtk_Popover_Record
    152. Gtk.Print_Context.Gtk_Print_Context_Record
    153. Gtk.Print_Operation.Gtk_Print_Operation_Record
    154. Gtk.Print_Settings.Gtk_Print_Settings_Record
    155. Gtk.Progress_Bar.Gtk_Progress_Bar_Record
    156. Gtk.Radio_Action.Gtk_Radio_Action_Record
    157. Gtk.Radio_Button.Gtk_Radio_Button_Record
    158. Gtk.Radio_Menu_Item.Gtk_Radio_Menu_Item_Record
    159. Gtk.Radio_Tool_Button.Gtk_Radio_Tool_Button_Record
    160. Gtk.Recent_Action.Gtk_Recent_Action_Record
    161. Gtk.Recent_Chooser_Dialog.Gtk_Recent_Chooser_Dialog_Record
    162. Gtk.Recent_Chooser_Menu.Gtk_Recent_Chooser_Menu_Record
    163. Gtk.Recent_Chooser_Widget.Gtk_Recent_Chooser_Widget_Record
    164. Gtk.Recent_Filter.Gtk_Recent_Filter_Record
    165. Gtk.Recent_Info.Gtk_Recent_Info
    166. Gtk.Recent_Manager.Gtk_Recent_Manager_Record
    167. Gtk.Revealer.Gtk_Revealer_Record
    168. Gtk.Scale.Gtk_Scale_Record
    169. Gtk.Scale_Button.Gtk_Scale_Button_Record
    170. Gtk.Scrollbar.Gtk_Scrollbar_Record
    171. Gtk.Scrolled_Window.Gtk_Scrolled_Window_Record
    172. Gtk.Search_Bar.Gtk_Search_Bar_Record
    173. Gtk.Search_Entry.Gtk_Search_Entry_Record
    174. Gtk.Selection_Data.Gtk_Selection_Data
    175. Gtk.Separator.Gtk_Separator_Record
    176. Gtk.Separator_Menu_Item.Gtk_Separator_Menu_Item_Record
    177. Gtk.Separator_Tool_Item.Gtk_Separator_Tool_Item_Record
    178. Gtk.Settings.Gtk_Settings_Record
    179. Gtk.Shortcuts_Window.Gtk_Shortcuts_Window_Record
    180. Gtk.Size_Group.Gtk_Size_Group_Record
    181. Gtk.Spin_Button.Gtk_Spin_Button_Record
    182. Gtk.Spinner.Gtk_Spinner_Record
    183. Gtk.Stack.Gtk_Stack_Record
    184. Gtk.Stack_Switcher.Gtk_Stack_Switcher_Record
    185. Gtk.Status_Bar.Gtk_Status_Bar_Record
    186. Gtk.Status_Icon.Gtk_Status_Icon_Record
    187. Gtk.Style.Gtk_Style_Record
    188. Gtk.Style_Context.Gtk_Style_Context_Record
    189. Gtk.Style_Properties.Gtk_Style_Properties_Record
    190. Gtk.Switch.Gtk_Switch_Record
    191. Gtk.Symbolic_Color.Gtk_Symbolic_Color
    192. Gtk.Table.Gtk_Table_Record
    193. Gtk.Target_List.Gtk_Target_List
    194. Gtk.Tearoff_Menu_Item.Gtk_Tearoff_Menu_Item_Record
    195. Gtk.Text_Buffer.Gtk_Text_Buffer_Record
    196. Gtk.Text_Child.Gtk_Text_Child_Anchor_Record
    197. Gtk.Text_Child_Anchor.Gtk_Text_Child_Anchor_Record
    198. Gtk.Text_Mark.Gtk_Text_Mark_Record
    199. Gtk.Text_Tag.Gtk_Text_Tag_Record
    200. Gtk.Text_Tag_Table.Gtk_Text_Tag_Table_Record
    201. Gtk.Text_View.Gtk_Text_View_Record
    202. Gtk.Theming_Engine.Gtk_Theming_Engine_Record
    203. Gtk.Toggle_Action.Gtk_Toggle_Action_Record
    204. Gtk.Toggle_Button.Gtk_Toggle_Button_Record
    205. Gtk.Toggle_Tool_Button.Gtk_Toggle_Tool_Button_Record
    206. Gtk.Tool_Button.Gtk_Tool_Button_Record
    207. Gtk.Tool_Item.Gtk_Tool_Item_Record
    208. Gtk.Tool_Item_Group.Gtk_Tool_Item_Group_Record
    209. Gtk.Tool_Palette.Gtk_Tool_Palette_Record
    210. Gtk.Toolbar.Gtk_Toolbar_Record
    211. Gtk.Tooltip.Gtk_Tooltip_Record
    212. Gtk.Tree_Model.Gtk_Root_Tree_Model_Record
    213. Gtk.Tree_Model.Gtk_Tree_Path
    214. Gtk.Tree_Model_Filter.Gtk_Tree_Model_Filter_Record
    215. Gtk.Tree_Model_Sort.Gtk_Tree_Model_Sort_Record
    216. Gtk.Tree_Row_Reference.Gtk_Tree_Row_Reference
    217. Gtk.Tree_Selection.Gtk_Tree_Selection_Record
    218. Gtk.Tree_Store.Gtk_Tree_Store_Record
    219. Gtk.Tree_View.Gtk_Tree_View_Record
    220. Gtk.Tree_View_Column.Gtk_Tree_View_Column_Record
    221. Gtk.UI_Manager.Gtk_UI_Manager_Record
    222. Gtk.Vbutton_Box.Gtk_Vbutton_Box_Record
    223. Gtk.Viewport.Gtk_Viewport_Record
    224. Gtk.Volume_Button.Gtk_Volume_Button_Record
    225. Gtk.Widget.Gtk_Widget_Record
    226. Gtk.Window.Gtk_Window_Group_Record
    227. Gtk.Window.Gtk_Window_Record
    228. Gtkada.Abstract_List_Model.Gtk_Abstract_List_Model_Record
    229. Gtkada.Abstract_Tree_Model.Gtk_Abstract_Tree_Model_Record
    230. Gtkada.Application.Gtkada_Application_Record
    231. Gtkada.Builder.Gtkada_Builder_Record
    232. Gtkada.Canvas.Buffered_Item_Record
    233. Gtkada.Canvas.Canvas_Item_Record
    234. Gtkada.Canvas.Canvas_Link_Record
    235. Gtkada.Canvas_View.Abstract_Item_Record
    236. Gtkada.Canvas.Interactive_Canvas_Record
    237. Gtkada.Canvas_View.Canvas_Item_Record
    238. Gtkada.Canvas_View.Canvas_Link_Record
    239. Gtkada.Canvas_View.Canvas_Model_Record
    240. Gtkada.Canvas_View.Canvas_View_Record
    241. Gtkada.Canvas_View.Container_Item_Record
    242. Gtkada.Canvas_View.Editable_Text_Item_Record
    243. Gtkada.Canvas_View.Ellipse_Item_Record
    244. Gtkada.Canvas_View.Hr_Item_Record
    245. Gtkada.Canvas_View.Image_Item_Record
    246. Gtkada.Canvas_View.Models.Rtree_Models.Rtree_Model_Record
    247. Gtkada.Canvas_View.List_Canvas_Model_Record
    248. Gtkada.Canvas_View.Polyline_Item_Record
    249. Gtkada.Canvas_View.Rtrees.Rtree
    250. Gtkada.Canvas_View.Rect_Item_Record
    251. Gtkada.Canvas_View.Text_Item_Record
    252. Gtkada.Canvas_View.Views.Animator
    253. Gtkada.Canvas_View.Views.Minimap_View_Record
    254. Gtkada.MDI.MDI_Child_Record
    255. Gtkada.MDI.MDI_Window_Record
    256. Gtkada.Multi_Paned.Gtkada_Multi_Paned_Record
    257. Gtkada.Multiline_Entry.Gtkada_Multiline_Entry_Record
    258. Gtkada.Printing.Gtkada_Print_Operation_Record
    259. Gtkada.Style.Drawing_Style
    260. Pango.Attributes.Pango_Attr_List
    261. Pango.Context.Pango_Context_Record
    262. Pango.Coverage.Pango_Coverage_Record
    263. Pango.Font.Pango_Font_Record
    264. Pango.Font_Face.Pango_Font_Face_Record
    265. Pango.Font_Family.Pango_Font_Family_Record
    266. Pango.Font_Map.Pango_Font_Map_Record
    267. Pango.Font_Metrics.Pango_Font_Metrics
    268. Pango.Fontset.Pango_Fontset_Record
    269. Pango.Language.Pango_Language
    270. Pango.Layout.Pango_Layout_Iter
    271. Pango.Layout.Pango_Layout_Record
    272. Pango.Tabs.Pango_Tab_Array

Gtk.Print_Operation

Description

GtkPrintOperation is the high-level, portable printing API. It looks a bit different than other GTK+ dialogs such as the Gtk.File_Chooser.Gtk_File_Chooser, since some platforms don't expose enough infrastructure to implement a good print dialog. On such platforms, GtkPrintOperation uses the native print dialog. On platforms which do not provide a native print dialog, GTK+ uses its own, see Gtk_Print_Unix_Dialog.

The typical way to use the high-level printing API is to create a GtkPrintOperation object with Gtk.Print_Operation.Gtk_New when the user selects to print. Then you set some properties on it, e.g. the page size, any Gtk.Print_Settings.Gtk_Print_Settings from previous print operations, the number of pages, the current page, etc.

Then you start the print operation by calling Gtk.Print_Operation.Run. It will then show a dialog, let the user select a printer and options. When the user finished the dialog various signals will be emitted on the Gtk.Print_Operation.Gtk_Print_Operation, the main one being Gtk.Print_Operation.Gtk_Print_Operation::draw-page, which you are supposed to catch and render the page on the provided Gtk.Print_Context.Gtk_Print_Context using Cairo.

# The high-level printing API

static GtkPrintSettings *settings = NULL;

static void
do_print (void)
{
  GtkPrintOperation *print;
  GtkPrintOperationResult res;

  print = gtk_print_operation_new ();

  if (settings != NULL)
    gtk_print_operation_set_print_settings (print, settings);

  g_signal_connect (print, "begin_print", G_CALLBACK (begin_print), NULL);
  g_signal_connect (print, "draw_page", G_CALLBACK (draw_page), NULL);

  res = gtk_print_operation_run (print, GTK_PRINT_OPERATION_ACTION_PRINT_DIALOG,
                                 GTK_WINDOW (main_window), NULL);

  if (res == GTK_PRINT_OPERATION_RESULT_APPLY)
    {
      if (settings != NULL)
        g_object_unref (settings);
      settings = g_object_ref (gtk_print_operation_get_print_settings (print));
    }

  g_object_unref (print);
}

By default GtkPrintOperation uses an external application to do print preview. To implement a custom print preview, an application must connect to the preview signal. The functions Gtk.Print_Operation_Preview.Render_Page, Gtk.Print_Operation_Preview.End_Preview and Gtk.Print_Operation_Preview.Is_Selected are useful when implementing a print preview.

"+"

function "+"
  (Widget : access Gtk_Print_Operation_Record'Class)
return Gtk.Print_Operation_Preview.Gtk_Print_Operation_Preview
Parameters
Widget
Return Value

"-"

function "-"
  (Interf : Gtk.Print_Operation_Preview.Gtk_Print_Operation_Preview)
return Gtk_Print_Operation
Parameters
Interf
Return Value

Allow_Async_Property

Allow_Async_Property : constant Glib.Properties.Property_Boolean;

Determines whether the print operation may run asynchronously or not.

Some systems don't support asynchronous printing, but those that do will return Gtk.Print_Operation.Result_In_Progress as the status, and emit the Gtk.Print_Operation.Gtk_Print_Operation::done signal when the operation is actually done.

The Windows port does not support asynchronous operation at all (this is unlikely to change). On other platforms, all actions except for Gtk.Print_Operation.Action_Export support asynchronous operation.

Cancel

procedure Cancel (Self : not null access Gtk_Print_Operation_Record)

Cancels a running print operation. This function may be called from a Gtk.Print_Operation.Gtk_Print_Operation::begin-print, Gtk.Print_Operation.Gtk_Print_Operation::paginate or Gtk.Print_Operation.Gtk_Print_Operation::draw-page signal handler to stop the currently running print operation. Since: gtk+ 2.10

Parameters
Self

Cb_GObject_GObject

type Cb_GObject_GObject is not null access function
  (Self : access Glib.Object.GObject_Record'Class)
return Glib.Object.GObject;
Parameters
Self
Return Value

Cb_GObject_Gtk_Print_Context_Boolean

type Cb_GObject_Gtk_Print_Context_Boolean is not null access function
  (Self    : access Glib.Object.GObject_Record'Class;
   Context : not null access Gtk.Print_Context.Gtk_Print_Context_Record'Class)
return Boolean;
Parameters
Self
Context
Return Value

Cb_GObject_Gtk_Print_Context_Gint_Gtk_Page_Setup_Void

type Cb_GObject_Gtk_Print_Context_Gint_Gtk_Page_Setup_Void is not null access procedure
  (Self    : access Glib.Object.GObject_Record'Class;
   Context : not null access Gtk.Print_Context.Gtk_Print_Context_Record'Class;
   Page_Nr : Glib.Gint;
   Setup   : not null access Gtk.Page_Setup.Gtk_Page_Setup_Record'Class);
Parameters
Self
Context
Page_Nr
Setup

Cb_GObject_Gtk_Print_Context_Gint_Void

type Cb_GObject_Gtk_Print_Context_Gint_Void is not null access procedure
  (Self    : access Glib.Object.GObject_Record'Class;
   Context : not null access Gtk.Print_Context.Gtk_Print_Context_Record'Class;
   Page_Nr : Glib.Gint);
Parameters
Self
Context
Page_Nr

Cb_GObject_Gtk_Print_Context_Void

type Cb_GObject_Gtk_Print_Context_Void is not null access procedure
  (Self    : access Glib.Object.GObject_Record'Class;
   Context : not null access Gtk.Print_Context.Gtk_Print_Context_Record'Class);
Parameters
Self
Context

Cb_GObject_Gtk_Print_Operation_Preview_Gtk_Print_Context_Gtk_Window_Boolean

type Cb_GObject_Gtk_Print_Operation_Preview_Gtk_Print_Context_Gtk_Window_Boolean is not null access function
  (Self    : access Glib.Object.GObject_Record'Class;
   Preview : Gtk.Print_Operation_Preview.Gtk_Print_Operation_Preview;
   Context : not null access Gtk.Print_Context.Gtk_Print_Context_Record'Class;
   Parent  : access Gtk.Window.Gtk_Window_Record'Class)
return Boolean;
Parameters
Self
Preview
Context
Parent
Return Value

Cb_GObject_Gtk_Print_Operation_Result_Void

type Cb_GObject_Gtk_Print_Operation_Result_Void is not null access procedure
  (Self   : access Glib.Object.GObject_Record'Class;
   Result : Gtk_Print_Operation_Result);
Parameters
Self
Result

Cb_GObject_Gtk_Widget_Gtk_Page_Setup_Gtk_Print_Settings_Void

type Cb_GObject_Gtk_Widget_Gtk_Page_Setup_Gtk_Print_Settings_Void is not null access procedure
  (Self     : access Glib.Object.GObject_Record'Class;
   Widget   : not null access Gtk.Widget.Gtk_Widget_Record'Class;
   Setup    : not null access Gtk.Page_Setup.Gtk_Page_Setup_Record'Class;
   Settings : not null access Gtk.Print_Settings.Gtk_Print_Settings_Record'Class);
Parameters
Self
Widget
Setup
Settings

Cb_GObject_Gtk_Widget_Void

type Cb_GObject_Gtk_Widget_Void is not null access procedure
  (Self   : access Glib.Object.GObject_Record'Class;
   Widget : not null access Gtk.Widget.Gtk_Widget_Record'Class);
Parameters
Self
Widget

Cb_GObject_Void

type Cb_GObject_Void is not null access procedure
  (Self : access Glib.Object.GObject_Record'Class);
Parameters
Self

Cb_Gtk_Print_Operation_GObject

type Cb_Gtk_Print_Operation_GObject is not null access function
  (Self : access Gtk_Print_Operation_Record'Class)
return Glib.Object.GObject;
Parameters
Self
Return Value

Cb_Gtk_Print_Operation_Gtk_Print_Context_Boolean

type Cb_Gtk_Print_Operation_Gtk_Print_Context_Boolean is not null access function
  (Self    : access Gtk_Print_Operation_Record'Class;
   Context : not null access Gtk.Print_Context.Gtk_Print_Context_Record'Class)
return Boolean;
Parameters
Self
Context
Return Value

Cb_Gtk_Print_Operation_Gtk_Print_Context_Gint_Gtk_Page_Setup_Void

type Cb_Gtk_Print_Operation_Gtk_Print_Context_Gint_Gtk_Page_Setup_Void is not null access procedure
  (Self    : access Gtk_Print_Operation_Record'Class;
   Context : not null access Gtk.Print_Context.Gtk_Print_Context_Record'Class;
   Page_Nr : Glib.Gint;
   Setup   : not null access Gtk.Page_Setup.Gtk_Page_Setup_Record'Class);
Parameters
Self
Context
Page_Nr
Setup

Cb_Gtk_Print_Operation_Gtk_Print_Context_Gint_Void

type Cb_Gtk_Print_Operation_Gtk_Print_Context_Gint_Void is not null access procedure
  (Self    : access Gtk_Print_Operation_Record'Class;
   Context : not null access Gtk.Print_Context.Gtk_Print_Context_Record'Class;
   Page_Nr : Glib.Gint);
Parameters
Self
Context
Page_Nr

Cb_Gtk_Print_Operation_Gtk_Print_Context_Void

type Cb_Gtk_Print_Operation_Gtk_Print_Context_Void is not null access procedure
  (Self    : access Gtk_Print_Operation_Record'Class;
   Context : not null access Gtk.Print_Context.Gtk_Print_Context_Record'Class);
Parameters
Self
Context

Cb_Gtk_Print_Operation_Gtk_Print_Operation_Preview_Gtk_Print_Context_Gtk_Window_Boolean

type Cb_Gtk_Print_Operation_Gtk_Print_Operation_Preview_Gtk_Print_Context_Gtk_Window_Boolean is not null access function
  (Self    : access Gtk_Print_Operation_Record'Class;
   Preview : Gtk.Print_Operation_Preview.Gtk_Print_Operation_Preview;
   Context : not null access Gtk.Print_Context.Gtk_Print_Context_Record'Class;
   Parent  : access Gtk.Window.Gtk_Window_Record'Class)
return Boolean;
Parameters
Self
Preview
Context
Parent
Return Value

Cb_Gtk_Print_Operation_Gtk_Print_Operation_Result_Void

type Cb_Gtk_Print_Operation_Gtk_Print_Operation_Result_Void is not null access procedure
  (Self   : access Gtk_Print_Operation_Record'Class;
   Result : Gtk_Print_Operation_Result);
Parameters
Self
Result

Cb_Gtk_Print_Operation_Gtk_Widget_Gtk_Page_Setup_Gtk_Print_Settings_Void

type Cb_Gtk_Print_Operation_Gtk_Widget_Gtk_Page_Setup_Gtk_Print_Settings_Void is not null access procedure
  (Self     : access Gtk_Print_Operation_Record'Class;
   Widget   : not null access Gtk.Widget.Gtk_Widget_Record'Class;
   Setup    : not null access Gtk.Page_Setup.Gtk_Page_Setup_Record'Class;
   Settings : not null access Gtk.Print_Settings.Gtk_Print_Settings_Record'Class);
Parameters
Self
Widget
Setup
Settings

Cb_Gtk_Print_Operation_Gtk_Widget_Void

type Cb_Gtk_Print_Operation_Gtk_Widget_Void is not null access procedure
  (Self   : access Gtk_Print_Operation_Record'Class;
   Widget : not null access Gtk.Widget.Gtk_Widget_Record'Class);
Parameters
Self
Widget

Cb_Gtk_Print_Operation_Void

type Cb_Gtk_Print_Operation_Void is not null access procedure
  (Self : access Gtk_Print_Operation_Record'Class);
Parameters
Self

Current_Page_Property

Current_Page_Property : constant Glib.Properties.Property_Int;

The current page in the document.

If this is set before Gtk.Print_Operation.Run, the user will be able to select to print only the current page.

Note that this only makes sense for pre-paginated documents.

Custom_Tab_Label_Property

Custom_Tab_Label_Property : constant Glib.Properties.Property_String;

Used as the label of the tab containing custom widgets. Note that this property may be ignored on some platforms.

If this is null, GTK+ uses a default label.

Default_Page_Setup_Property

Default_Page_Setup_Property : constant Glib.Properties.Property_Object;

Type: Gtk.Page_Setup.Gtk_Page_Setup The Gtk.Page_Setup.Gtk_Page_Setup used by default.

This page setup will be used by Gtk.Print_Operation.Run, but it can be overridden on a per-page basis by connecting to the Gtk.Print_Operation.Gtk_Print_Operation::request-page-setup signal.

Draw_Page_Finish

procedure Draw_Page_Finish
   (Self : not null access Gtk_Print_Operation_Record)

Signalize that drawing of particular page is complete. It is called after completion of page drawing (e.g. drawing in another thread). If Gtk.Print_Operation.Set_Defer_Drawing was called before, then this function has to be called by application. In another case it is called by the library itself. Since: gtk+ 2.16

Parameters
Self

Embed_Page_Setup_Property

Embed_Page_Setup_Property : constant Glib.Properties.Property_Boolean;

If True, page size combo box and orientation combo box are embedded into page setup page.

End_Preview

procedure End_Preview
   (Preview : not null access Gtk_Print_Operation_Record)
Parameters
Preview

Export_Filename_Property

Export_Filename_Property : constant Glib.Properties.Property_String;

The name of a file to generate instead of showing the print dialog. Currently, PDF is the only supported format.

The intended use of this property is for implementing "Export to PDF" actions.

"Print to PDF" support is independent of this and is done by letting the user pick the "Print to PDF" item from the list of printers in the print dialog.

Get_Default_Page_Setup

function Get_Default_Page_Setup
   (Self : not null access Gtk_Print_Operation_Record)
    return Gtk.Page_Setup.Gtk_Page_Setup

Returns the default page setup, see Gtk.Print_Operation.Set_Default_Page_Setup. Since: gtk+ 2.10

Parameters
Self
Return Value

the default page setup

Get_Embed_Page_Setup

function Get_Embed_Page_Setup
   (Self : not null access Gtk_Print_Operation_Record) return Boolean

Gets the value of Gtk.Print_Operation.Gtk_Print_Operation:embed-page-setup property. Since: gtk+ 2.18

Parameters
Self
Return Value

whether page setup selection combos are embedded

Get_Error

procedure Get_Error (Self : not null access Gtk_Print_Operation_Record)

Call this when the result of a print operation is Gtk.Print_Operation.Result_Error, either as returned by Gtk.Print_Operation.Run, or in the Gtk.Print_Operation.Gtk_Print_Operation::done signal handler. The returned Gerror.Gerror will contain more details on what went wrong. Since: gtk+ 2.10

Parameters
Self

Get_Has_Selection

function Get_Has_Selection
   (Self : not null access Gtk_Print_Operation_Record) return Boolean

Gets the value of Gtk.Print_Operation.Gtk_Print_Operation:has-selection property. Since: gtk+ 2.18

Parameters
Self
Return Value

whether there is a selection

Get_N_Pages_To_Print

function Get_N_Pages_To_Print
   (Self : not null access Gtk_Print_Operation_Record) return Glib.Gint

Returns the number of pages that will be printed. Note that this value is set during print preparation phase (Gtk.Print_Operation.Status_Preparing), so this function should never be called before the data generation phase (Gtk.Print_Operation.Status_Generating_Data). You can connect to the Gtk.Print_Operation.Gtk_Print_Operation::status-changed signal and call Gtk.Print_Operation.Get_N_Pages_To_Print when print status is Gtk.Print_Operation.Status_Generating_Data. This is typically used to track the progress of print operation. Since: gtk+ 2.18

Parameters
Self
Return Value

the number of pages that will be printed

Get_Print_Settings

function Get_Print_Settings
   (Self : not null access Gtk_Print_Operation_Record)
    return Gtk.Print_Settings.Gtk_Print_Settings

Returns the current print settings. Note that the return value is null until either Gtk.Print_Operation.Set_Print_Settings or Gtk.Print_Operation.Run have been called. Since: gtk+ 2.10

Parameters
Self
Return Value

the current print settings of Op.

Get_Status

function Get_Status
   (Self : not null access Gtk_Print_Operation_Record)
    return Gtk_Print_Status

Returns the status of the print operation. Also see Gtk.Print_Operation.Get_Status_String. Since: gtk+ 2.10

Parameters
Self
Return Value

the status of the print operation

Get_Status_String

function Get_Status_String
   (Self : not null access Gtk_Print_Operation_Record) return UTF8_String

Returns a string representation of the status of the print operation. The string is translated and suitable for displaying the print status e.g. in a Gtk.Status_Bar.Gtk_Status_Bar. Use Gtk.Print_Operation.Get_Status to obtain a status value that is suitable for programmatic use. Since: gtk+ 2.10

Parameters
Self
Return Value

a string representation of the status of the print operation

Get_Support_Selection

function Get_Support_Selection
   (Self : not null access Gtk_Print_Operation_Record) return Boolean

Gets the value of Gtk.Print_Operation.Gtk_Print_Operation:support-selection property. Since: gtk+ 2.18

Parameters
Self
Return Value

whether the application supports print of selection

Get_Type

function Get_Type return Glib.GType
Return Value

Gtk_New

procedure Gtk_New (Self : out Gtk_Print_Operation)

Creates a new Gtk.Print_Operation.Gtk_Print_Operation. Since: gtk+ 2.10 Initialize does nothing if the object was already created with another call to Initialize* or G_New.

Parameters
Self

Gtk_Print_Error

type Gtk_Print_Error is (
   Error_General,
   Error_Internal_Error,
   Error_Nomem,
   Error_Invalid_File);

Error codes that identify various errors that can occur while using the GTK+ printing support.

Enumeration Literal
Error_General
Error_Internal_Error
Error_Nomem
Error_Invalid_File

Gtk_Print_Error_Properties

package Gtk_Print_Error_Properties is
   new Generic_Internal_Discrete_Property (Gtk_Print_Error);

Gtk_Print_Operation

type Gtk_Print_Operation is access all Gtk_Print_Operation_Record'Class;

Gtk_Print_Operation_Action

type Gtk_Print_Operation_Action is (
   Action_Print_Dialog,
   Action_Print,
   Action_Preview,
   Action_Export);

The Action parameter to Gtk.Print_Operation.Run determines what action the print operation should perform.

Enumeration Literal
Action_Print_Dialog
Action_Print
Action_Preview
Action_Export

Gtk_Print_Operation_Action_Properties

package Gtk_Print_Operation_Action_Properties is
   new Generic_Internal_Discrete_Property (Gtk_Print_Operation_Action);

Gtk_Print_Operation_New

function Gtk_Print_Operation_New return Gtk_Print_Operation

Creates a new Gtk.Print_Operation.Gtk_Print_Operation. Since: gtk+ 2.10

Return Value

Gtk_Print_Operation_Record

type Gtk_Print_Operation_Record is new GObject_Record with null record;

Gtk_Print_Operation_Result

type Gtk_Print_Operation_Result is (
   Result_Error,
   Result_Apply,
   Result_Cancel,
   Result_In_Progress);

A value of this type is returned by Gtk.Print_Operation.Run.

Enumeration Literal
Result_Error
Result_Apply
Result_Cancel
Result_In_Progress

Gtk_Print_Operation_Result_Properties

package Gtk_Print_Operation_Result_Properties is
   new Generic_Internal_Discrete_Property (Gtk_Print_Operation_Result);

Gtk_Print_Status

type Gtk_Print_Status is (
   Status_Initial,
   Status_Preparing,
   Status_Generating_Data,
   Status_Sending_Data,
   Status_Pending,
   Status_Pending_Issue,
   Status_Printing,
   Status_Finished,
   Status_Finished_Aborted);

The status gives a rough indication of the completion of a running print operation.

Enumeration Literal
Status_Initial
Status_Preparing
Status_Generating_Data
Status_Sending_Data
Status_Pending
Status_Pending_Issue
Status_Printing
Status_Finished
Status_Finished_Aborted

Gtk_Print_Status_Properties

package Gtk_Print_Status_Properties is
   new Generic_Internal_Discrete_Property (Gtk_Print_Status);

Has_Selection_Property

Has_Selection_Property : constant Glib.Properties.Property_Boolean;

Determines whether there is a selection in your application. This can allow your application to print the selection. This is typically used to make a "Selection" button sensitive.

Implements_Gtk_Print_Operation_Preview

package Implements_Gtk_Print_Operation_Preview is new Glib.Types.Implements
  (Gtk.Print_Operation_Preview.Gtk_Print_Operation_Preview, Gtk_Print_Operation_Record, Gtk_Print_Operation);

Initialize

procedure Initialize
   (Self : not null access Gtk_Print_Operation_Record'Class)

Creates a new Gtk.Print_Operation.Gtk_Print_Operation. Since: gtk+ 2.10 Initialize does nothing if the object was already created with another call to Initialize* or G_New.

Parameters
Self

Is_Finished

function Is_Finished
   (Self : not null access Gtk_Print_Operation_Record) return Boolean

A convenience function to find out if the print operation is finished, either successfully (Gtk.Print_Operation.Status_Finished) or unsuccessfully (Gtk.Print_Operation.Status_Finished_Aborted). Note: when you enable print status tracking the print operation can be in a non-finished state even after done has been called, as the operation status then tracks the print job status on the printer. Since: gtk+ 2.10

Parameters
Self
Return Value

True, if the print operation is finished.

Is_Selected

function Is_Selected
   (Preview : not null access Gtk_Print_Operation_Record;
    Page_Nr : Glib.Gint) return Boolean
Parameters
Preview
Page_Nr
Return Value

Job_Name_Property

Job_Name_Property : constant Glib.Properties.Property_String;

A string used to identify the job (e.g. in monitoring applications like eggcups).

If you don't set a job name, GTK+ picks a default one by numbering successive print jobs.

N_Pages_Property

N_Pages_Property : constant Glib.Properties.Property_Int;

The number of pages in the document.

This must be set to a positive number before the rendering starts. It may be set in a Gtk.Print_Operation.Gtk_Print_Operation::begin-print signal hander.

Note that the page numbers passed to the Gtk.Print_Operation.Gtk_Print_Operation::request-page-setup and Gtk.Print_Operation.Gtk_Print_Operation::draw-page signals are 0-based, i.e. if the user chooses to print all pages, the last ::draw-page signal will be for page N_Pages - 1.

N_Pages_To_Print_Property

N_Pages_To_Print_Property : constant Glib.Properties.Property_Int;

The number of pages that will be printed.

Note that this value is set during print preparation phase (Gtk.Print_Operation.Status_Preparing), so this value should never be get before the data generation phase (Gtk.Print_Operation.Status_Generating_Data). You can connect to the Gtk.Print_Operation.Gtk_Print_Operation::status-changed signal and call Gtk.Print_Operation.Get_N_Pages_To_Print when print status is Gtk.Print_Operation.Status_Generating_Data. This is typically used to track the progress of print operation.

On_Begin_Print

procedure On_Begin_Print
   (Self  : not null access Gtk_Print_Operation_Record;
    Call  : Cb_GObject_Gtk_Print_Context_Void;
    Slot  : not null access Glib.Object.GObject_Record'Class;
    After : Boolean := False)

Emitted after the user has finished changing print settings in the dialog, before the actual rendering starts.

A typical use for ::begin-print is to use the parameters from the Gtk.Print_Context.Gtk_Print_Context and paginate the document accordingly, and then set the number of pages with Gtk.Print_Operation.Set_N_Pages.

Parameters
Self
Call
Slot
After

On_Begin_Print

procedure On_Begin_Print
   (Self  : not null access Gtk_Print_Operation_Record;
    Call  : Cb_Gtk_Print_Operation_Gtk_Print_Context_Void;
    After : Boolean := False)

Emitted after the user has finished changing print settings in the dialog, before the actual rendering starts.

A typical use for ::begin-print is to use the parameters from the Gtk.Print_Context.Gtk_Print_Context and paginate the document accordingly, and then set the number of pages with Gtk.Print_Operation.Set_N_Pages.

Parameters
Self
Call
After

On_Create_Custom_Widget

procedure On_Create_Custom_Widget
   (Self  : not null access Gtk_Print_Operation_Record;
    Call  : Cb_GObject_GObject;
    Slot  : not null access Glib.Object.GObject_Record'Class;
    After : Boolean := False)

Emitted when displaying the print dialog. If you return a widget in a handler for this signal it will be added to a custom tab in the print dialog. You typically return a container widget with multiple widgets in it.

The print dialog owns the returned widget, and its lifetime is not controlled by the application. However, the widget is guaranteed to stay around until the Gtk.Print_Operation.Gtk_Print_Operation::custom-widget-apply signal is emitted on the operation. Then you can read out any information you need from the widgets.

Callback parameters:

Parameters
Self
Call
Slot
After

On_Create_Custom_Widget

procedure On_Create_Custom_Widget
   (Self  : not null access Gtk_Print_Operation_Record;
    Call  : Cb_Gtk_Print_Operation_GObject;
    After : Boolean := False)

Emitted when displaying the print dialog. If you return a widget in a handler for this signal it will be added to a custom tab in the print dialog. You typically return a container widget with multiple widgets in it.

The print dialog owns the returned widget, and its lifetime is not controlled by the application. However, the widget is guaranteed to stay around until the Gtk.Print_Operation.Gtk_Print_Operation::custom-widget-apply signal is emitted on the operation. Then you can read out any information you need from the widgets.

Callback parameters:

Parameters
Self
Call
After

On_Custom_Widget_Apply

procedure On_Custom_Widget_Apply
   (Self  : not null access Gtk_Print_Operation_Record;
    Call  : Cb_GObject_Gtk_Widget_Void;
    Slot  : not null access Glib.Object.GObject_Record'Class;
    After : Boolean := False)

Emitted right before Gtk.Print_Operation.Gtk_Print_Operation::begin-print if you added a custom widget in the Gtk.Print_Operation.Gtk_Print_Operation::create-custom-widget handler. When you get this signal you should read the information from the custom widgets, as the widgets are not guaraneed to be around at a later time.

Parameters
Self
Call
Slot
After

On_Custom_Widget_Apply

procedure On_Custom_Widget_Apply
   (Self  : not null access Gtk_Print_Operation_Record;
    Call  : Cb_Gtk_Print_Operation_Gtk_Widget_Void;
    After : Boolean := False)

Emitted right before Gtk.Print_Operation.Gtk_Print_Operation::begin-print if you added a custom widget in the Gtk.Print_Operation.Gtk_Print_Operation::create-custom-widget handler. When you get this signal you should read the information from the custom widgets, as the widgets are not guaraneed to be around at a later time.

Parameters
Self
Call
After

On_Done

procedure On_Done
   (Self  : not null access Gtk_Print_Operation_Record;
    Call  : Cb_GObject_Gtk_Print_Operation_Result_Void;
    Slot  : not null access Glib.Object.GObject_Record'Class;
    After : Boolean := False)

Emitted when the print operation run has finished doing everything required for printing.

Result gives you information about what happened during the run. If Result is Gtk.Print_Operation.Result_Error then you can call Gtk.Print_Operation.Get_Error for more information.

If you enabled print status tracking then Gtk.Print_Operation.Is_Finished may still return False after Gtk.Print_Operation.Gtk_Print_Operation::done was emitted.

Parameters
Self
Call
Slot
After

On_Done

procedure On_Done
   (Self  : not null access Gtk_Print_Operation_Record;
    Call  : Cb_Gtk_Print_Operation_Gtk_Print_Operation_Result_Void;
    After : Boolean := False)

Emitted when the print operation run has finished doing everything required for printing.

Result gives you information about what happened during the run. If Result is Gtk.Print_Operation.Result_Error then you can call Gtk.Print_Operation.Get_Error for more information.

If you enabled print status tracking then Gtk.Print_Operation.Is_Finished may still return False after Gtk.Print_Operation.Gtk_Print_Operation::done was emitted.

Parameters
Self
Call
After

On_Draw_Page

procedure On_Draw_Page
   (Self  : not null access Gtk_Print_Operation_Record;
    Call  : Cb_GObject_Gtk_Print_Context_Gint_Void;
    Slot  : not null access Glib.Object.GObject_Record'Class;
    After : Boolean := False)

Emitted for every page that is printed. The signal handler must render the Page_Nr's page onto the cairo context obtained from Context using Gtk.Print_Context.Get_Cairo_Context.

static void
draw_page (GtkPrintOperation *operation,
           GtkPrintContext   *context,
           gint               page_nr,
           gpointer           user_data)
{
  cairo_t *cr;
  PangoLayout *layout;
  gdouble width, text_height;
  gint layout_height;
  PangoFontDescription *desc;

  cr = gtk_print_context_get_cairo_context (context);
  width = gtk_print_context_get_width (context);

  cairo_rectangle (cr, 0, 0, width, HEADER_HEIGHT);

  cairo_set_source_rgb (cr, 0.8, 0.8, 0.8);
  cairo_fill (cr);

  layout = gtk_print_context_create_pango_layout (context);

  desc = pango_font_description_from_string ("sans 14");
  pango_layout_set_font_description (layout, desc);
  pango_font_description_free (desc);

  pango_layout_set_text (layout, "some text", -1);
  pango_layout_set_width (layout, width * PANGO_SCALE);
  pango_layout_set_alignment (layout, PANGO_ALIGN_CENTER);

  pango_layout_get_size (layout, NULL, &layout_height);
  text_height = (gdouble)layout_height / PANGO_SCALE;

  cairo_move_to (cr, width / 2,  (HEADER_HEIGHT - text_height) / 2);
  pango_cairo_show_layout (cr, layout);

  g_object_unref (layout);
}

Use Gtk.Print_Operation.Set_Use_Full_Page and Gtk.Print_Operation.Set_Unit before starting the print operation to set up the transformation of the cairo context according to your needs.

Callback parameters: -- @param Context the Gtk.Print_Context.Gtk_Print_Context for the current -- operation -- @param Page_Nr the number of the currently printed page (0-based)

Parameters
Self
Call
Slot
After

On_Draw_Page

procedure On_Draw_Page
   (Self  : not null access Gtk_Print_Operation_Record;
    Call  : Cb_Gtk_Print_Operation_Gtk_Print_Context_Gint_Void;
    After : Boolean := False)

Emitted for every page that is printed. The signal handler must render the Page_Nr's page onto the cairo context obtained from Context using Gtk.Print_Context.Get_Cairo_Context.

static void
draw_page (GtkPrintOperation *operation,
           GtkPrintContext   *context,
           gint               page_nr,
           gpointer           user_data)
{
  cairo_t *cr;
  PangoLayout *layout;
  gdouble width, text_height;
  gint layout_height;
  PangoFontDescription *desc;

  cr = gtk_print_context_get_cairo_context (context);
  width = gtk_print_context_get_width (context);

  cairo_rectangle (cr, 0, 0, width, HEADER_HEIGHT);

  cairo_set_source_rgb (cr, 0.8, 0.8, 0.8);
  cairo_fill (cr);

  layout = gtk_print_context_create_pango_layout (context);

  desc = pango_font_description_from_string ("sans 14");
  pango_layout_set_font_description (layout, desc);
  pango_font_description_free (desc);

  pango_layout_set_text (layout, "some text", -1);
  pango_layout_set_width (layout, width * PANGO_SCALE);
  pango_layout_set_alignment (layout, PANGO_ALIGN_CENTER);

  pango_layout_get_size (layout, NULL, &layout_height);
  text_height = (gdouble)layout_height / PANGO_SCALE;

  cairo_move_to (cr, width / 2,  (HEADER_HEIGHT - text_height) / 2);
  pango_cairo_show_layout (cr, layout);

  g_object_unref (layout);
}

Use Gtk.Print_Operation.Set_Use_Full_Page and Gtk.Print_Operation.Set_Unit before starting the print operation to set up the transformation of the cairo context according to your needs.

Callback parameters: -- @param Context the Gtk.Print_Context.Gtk_Print_Context for the current -- operation -- @param Page_Nr the number of the currently printed page (0-based)

Parameters
Self
Call
After

On_End_Print

procedure On_End_Print
   (Self  : not null access Gtk_Print_Operation_Record;
    Call  : Cb_GObject_Gtk_Print_Context_Void;
    Slot  : not null access Glib.Object.GObject_Record'Class;
    After : Boolean := False)

Emitted after all pages have been rendered. A handler for this signal can clean up any resources that have been allocated in the Gtk.Print_Operation.Gtk_Print_Operation::begin-print handler.

Parameters
Self
Call
Slot
After

On_End_Print

procedure On_End_Print
   (Self  : not null access Gtk_Print_Operation_Record;
    Call  : Cb_Gtk_Print_Operation_Gtk_Print_Context_Void;
    After : Boolean := False)

Emitted after all pages have been rendered. A handler for this signal can clean up any resources that have been allocated in the Gtk.Print_Operation.Gtk_Print_Operation::begin-print handler.

Parameters
Self
Call
After

On_Paginate

procedure On_Paginate
   (Self  : not null access Gtk_Print_Operation_Record;
    Call  : Cb_GObject_Gtk_Print_Context_Boolean;
    Slot  : not null access Glib.Object.GObject_Record'Class;
    After : Boolean := False)

Emitted after the Gtk.Print_Operation.Gtk_Print_Operation::begin-print signal, but before the actual rendering starts. It keeps getting emitted until a connected signal handler returns True.

The ::paginate signal is intended to be used for paginating a document in small chunks, to avoid blocking the user interface for a long time. The signal handler should update the number of pages using Gtk.Print_Operation.Set_N_Pages, and return True if the document has been completely paginated.

If you don't need to do pagination in chunks, you can simply do it all in the ::begin-print handler, and set the number of pages from there.

Callback parameters: -- @param Context the Gtk.Print_Context.Gtk_Print_Context for the current -- operation

Parameters
Self
Call
Slot
After

On_Paginate

procedure On_Paginate
   (Self  : not null access Gtk_Print_Operation_Record;
    Call  : Cb_Gtk_Print_Operation_Gtk_Print_Context_Boolean;
    After : Boolean := False)

Emitted after the Gtk.Print_Operation.Gtk_Print_Operation::begin-print signal, but before the actual rendering starts. It keeps getting emitted until a connected signal handler returns True.

The ::paginate signal is intended to be used for paginating a document in small chunks, to avoid blocking the user interface for a long time. The signal handler should update the number of pages using Gtk.Print_Operation.Set_N_Pages, and return True if the document has been completely paginated.

If you don't need to do pagination in chunks, you can simply do it all in the ::begin-print handler, and set the number of pages from there.

Callback parameters: -- @param Context the Gtk.Print_Context.Gtk_Print_Context for the current -- operation

Parameters
Self
Call
After

On_Preview

procedure On_Preview
   (Self  : not null access Gtk_Print_Operation_Record;
    Call  : Cb_GObject_Gtk_Print_Operation_Preview_Gtk_Print_Context_Gtk_Window_Boolean;
    Slot  : not null access Glib.Object.GObject_Record'Class;
    After : Boolean := False)

Gets emitted when a preview is requested from the native dialog.

The default handler for this signal uses an external viewer application to preview.

To implement a custom print preview, an application must return True from its handler for this signal. In order to use the provided Context for the preview implementation, it must be given a suitable cairo context with Gtk.Print_Context.Set_Cairo_Context.

The custom preview implementation can use Gtk.Print_Operation_Preview.Is_Selected and Gtk.Print_Operation_Preview.Render_Page to find pages which are selected for print and render them. The preview must be finished by calling Gtk.Print_Operation_Preview.End_Preview (typically in response to the user clicking a close button).

Callback parameters: -- @param Preview the -- Gtk.Print_Operation_Preview.Gtk_Print_Operation_Preview for the current -- operation -- @param Context the Gtk.Print_Context.Gtk_Print_Context that will be -- used -- @param Parent the Gtk.Window.Gtk_Window to use as window parent, or -- null

Parameters
Self
Call
Slot
After

On_Preview

procedure On_Preview
   (Self  : not null access Gtk_Print_Operation_Record;
    Call  : Cb_Gtk_Print_Operation_Gtk_Print_Operation_Preview_Gtk_Print_Context_Gtk_Window_Boolean;
    After : Boolean := False)

Gets emitted when a preview is requested from the native dialog.

The default handler for this signal uses an external viewer application to preview.

To implement a custom print preview, an application must return True from its handler for this signal. In order to use the provided Context for the preview implementation, it must be given a suitable cairo context with Gtk.Print_Context.Set_Cairo_Context.

The custom preview implementation can use Gtk.Print_Operation_Preview.Is_Selected and Gtk.Print_Operation_Preview.Render_Page to find pages which are selected for print and render them. The preview must be finished by calling Gtk.Print_Operation_Preview.End_Preview (typically in response to the user clicking a close button).

Callback parameters: -- @param Preview the -- Gtk.Print_Operation_Preview.Gtk_Print_Operation_Preview for the current -- operation -- @param Context the Gtk.Print_Context.Gtk_Print_Context that will be -- used -- @param Parent the Gtk.Window.Gtk_Window to use as window parent, or -- null

Parameters
Self
Call
After

On_Request_Page_Setup

procedure On_Request_Page_Setup
   (Self  : not null access Gtk_Print_Operation_Record;
    Call  : Cb_GObject_Gtk_Print_Context_Gint_Gtk_Page_Setup_Void;
    Slot  : not null access Glib.Object.GObject_Record'Class;
    After : Boolean := False)

Emitted once for every page that is printed, to give the application a chance to modify the page setup. Any changes done to Setup will be in force only for printing this page.

Callback parameters: -- @param Context the Gtk.Print_Context.Gtk_Print_Context for the current -- operation -- @param Page_Nr the number of the currently printed page (0-based) -- @param Setup the Gtk.Page_Setup.Gtk_Page_Setup

Parameters
Self
Call
Slot
After

On_Request_Page_Setup

procedure On_Request_Page_Setup
   (Self  : not null access Gtk_Print_Operation_Record;
    Call  : Cb_Gtk_Print_Operation_Gtk_Print_Context_Gint_Gtk_Page_Setup_Void;
    After : Boolean := False)

Emitted once for every page that is printed, to give the application a chance to modify the page setup. Any changes done to Setup will be in force only for printing this page.

Callback parameters: -- @param Context the Gtk.Print_Context.Gtk_Print_Context for the current -- operation -- @param Page_Nr the number of the currently printed page (0-based) -- @param Setup the Gtk.Page_Setup.Gtk_Page_Setup

Parameters
Self
Call
After

On_Status_Changed

procedure On_Status_Changed
   (Self  : not null access Gtk_Print_Operation_Record;
    Call  : Cb_GObject_Void;
    Slot  : not null access Glib.Object.GObject_Record'Class;
    After : Boolean := False)

Emitted at between the various phases of the print operation. See Gtk.Print_Operation.Gtk_Print_Status for the phases that are being discriminated. Use Gtk.Print_Operation.Get_Status to find out the current status.

Parameters
Self
Call
Slot
After

On_Status_Changed

procedure On_Status_Changed
   (Self  : not null access Gtk_Print_Operation_Record;
    Call  : Cb_Gtk_Print_Operation_Void;
    After : Boolean := False)

Emitted at between the various phases of the print operation. See Gtk.Print_Operation.Gtk_Print_Status for the phases that are being discriminated. Use Gtk.Print_Operation.Get_Status to find out the current status.

Parameters
Self
Call
After

On_Update_Custom_Widget

procedure On_Update_Custom_Widget
   (Self  : not null access Gtk_Print_Operation_Record;
    Call  : Cb_GObject_Gtk_Widget_Gtk_Page_Setup_Gtk_Print_Settings_Void;
    Slot  : not null access Glib.Object.GObject_Record'Class;
    After : Boolean := False)

Emitted after change of selected printer. The actual page setup and print settings are passed to the custom widget, which can actualize itself according to this change.

Callback parameters: -- @param Widget the custom widget added in create-custom-widget -- @param Setup actual page setup -- @param Settings actual print settings

Parameters
Self
Call
Slot
After

On_Update_Custom_Widget

procedure On_Update_Custom_Widget
   (Self  : not null access Gtk_Print_Operation_Record;
    Call  : Cb_Gtk_Print_Operation_Gtk_Widget_Gtk_Page_Setup_Gtk_Print_Settings_Void;
    After : Boolean := False)

Emitted after change of selected printer. The actual page setup and print settings are passed to the custom widget, which can actualize itself according to this change.

Callback parameters: -- @param Widget the custom widget added in create-custom-widget -- @param Setup actual page setup -- @param Settings actual print settings

Parameters
Self
Call
After

Print_Settings_Property

Print_Settings_Property : constant Glib.Properties.Property_Object;

Type: Gtk.Print_Settings.Gtk_Print_Settings The Gtk.Print_Settings.Gtk_Print_Settings used for initializing the dialog.

Setting this property is typically used to re-establish print settings from a previous print operation, see Gtk.Print_Operation.Run.

Property_Gtk_Print_Error

type Property_Gtk_Print_Error is new Gtk_Print_Error_Properties.Property;

Property_Gtk_Print_Operation_Action

type Property_Gtk_Print_Operation_Action is new Gtk_Print_Operation_Action_Properties.Property;

Property_Gtk_Print_Operation_Result

type Property_Gtk_Print_Operation_Result is new Gtk_Print_Operation_Result_Properties.Property;

Property_Gtk_Print_Status

type Property_Gtk_Print_Status is new Gtk_Print_Status_Properties.Property;

Render_Page

procedure Render_Page
   (Preview : not null access Gtk_Print_Operation_Record;
    Page_Nr : Glib.Gint)
Parameters
Preview
Page_Nr

Run

function Run
   (Self   : not null access Gtk_Print_Operation_Record;
    Action : Gtk_Print_Operation_Action;
    Parent : access Gtk.Window.Gtk_Window_Record'Class)
    return Gtk_Print_Operation_Result

Runs the print operation, by first letting the user modify print settings in the print dialog, and then print the document. Normally that this function does not return until the rendering of all pages is complete. You can connect to the Gtk.Print_Operation.Gtk_Print_Operation::status-changed signal on Op to obtain some information about the progress of the print operation. Furthermore, it may use a recursive mainloop to show the print dialog. If you call Gtk.Print_Operation.Set_Allow_Async or set the Gtk.Print_Operation.Gtk_Print_Operation:allow-async property the operation will run asynchronously if this is supported on the platform. The Gtk.Print_Operation.Gtk_Print_Operation::done signal will be emitted with the result of the operation when the it is done (i.e. when the dialog is canceled, or when the print succeeds or fails).

if (settings != NULL)
  gtk_print_operation_set_print_settings (print, settings);

if (page_setup != NULL)
  gtk_print_operation_set_default_page_setup (print, page_setup);

g_signal_connect (print, "begin-print",
                  G_CALLBACK (begin_print), &data);
g_signal_connect (print, "draw-page",
                  G_CALLBACK (draw_page), &data);

res = gtk_print_operation_run (print,
                               GTK_PRINT_OPERATION_ACTION_PRINT_DIALOG,
                               parent,
                               &error);

if (res == GTK_PRINT_OPERATION_RESULT_ERROR)
 {
   error_dialog = gtk_message_dialog_new (GTK_WINDOW (parent),
  			                     GTK_DIALOG_DESTROY_WITH_PARENT,
					     GTK_MESSAGE_ERROR,
					     GTK_BUTTONS_CLOSE,
					     "Error printing file:\n%s",
					     error->message);
   g_signal_connect (error_dialog, "response",
                     G_CALLBACK (gtk_widget_destroy), NULL);
   gtk_widget_show (error_dialog);
   g_error_free (error);
 }
else if (res == GTK_PRINT_OPERATION_RESULT_APPLY)
 {
   if (settings != NULL)
g_object_unref (settings);
   settings = g_object_ref (gtk_print_operation_get_print_settings (print));
 }

Note that Gtk.Print_Operation.Run can only be called once on a given Gtk.Print_Operation.Gtk_Print_Operation. Since: gtk+ 2.10

Parameters
Self
Action

the action to start

Parent

Transient parent of the dialog

Return Value

the result of the print operation. A return value of Gtk.Print_Operation.Result_Apply indicates that the printing was completed successfully. In this case, it is a good idea to obtain the used print settings with Gtk.Print_Operation.Get_Print_Settings and store them for reuse with the next print operation. A value of Gtk.Print_Operation.Result_In_Progress means the operation is running asynchronously, and will emit the Gtk.Print_Operation.Gtk_Print_Operation::done signal when done.

Set_Allow_Async

procedure Set_Allow_Async
   (Self        : not null access Gtk_Print_Operation_Record;
    Allow_Async : Boolean)

Sets whether the Gtk.Print_Operation.Run may return before the print operation is completed. Note that some platforms may not allow asynchronous operation. Since: gtk+ 2.10

Parameters
Self
Allow_Async

True to allow asynchronous operation

Set_Current_Page

procedure Set_Current_Page
   (Self         : not null access Gtk_Print_Operation_Record;
    Current_Page : Glib.Gint)

Sets the current page. If this is called before Gtk.Print_Operation.Run, the user will be able to select to print only the current page. Note that this only makes sense for pre-paginated documents. Since: gtk+ 2.10

Parameters
Self
Current_Page

the current page, 0-based

Set_Custom_Tab_Label

procedure Set_Custom_Tab_Label
   (Self  : not null access Gtk_Print_Operation_Record;
    Label : UTF8_String := "")

Sets the label for the tab holding custom widgets. Since: gtk+ 2.10

Parameters
Self
Label

the label to use, or null to use the default label

Set_Default_Page_Setup

procedure Set_Default_Page_Setup
   (Self               : not null access Gtk_Print_Operation_Record;
    Default_Page_Setup : access Gtk.Page_Setup.Gtk_Page_Setup_Record'Class)

Makes Default_Page_Setup the default page setup for Op. This page setup will be used by Gtk.Print_Operation.Run, but it can be overridden on a per-page basis by connecting to the Gtk.Print_Operation.Gtk_Print_Operation::request-page-setup signal. Since: gtk+ 2.10

Parameters
Self
Default_Page_Setup

a Gtk.Page_Setup.Gtk_Page_Setup, or null

Set_Defer_Drawing

procedure Set_Defer_Drawing
   (Self : not null access Gtk_Print_Operation_Record)

Sets up the Gtk.Print_Operation.Gtk_Print_Operation to wait for calling of Gtk.Print_Operation.Draw_Page_Finish from application. It can be used for drawing page in another thread. This function must be called in the callback of "draw-page" signal. Since: gtk+ 2.16

Parameters
Self

Set_Embed_Page_Setup

procedure Set_Embed_Page_Setup
   (Self  : not null access Gtk_Print_Operation_Record;
    Embed : Boolean)

Embed page size combo box and orientation combo box into page setup page. Selected page setup is stored as default page setup in Gtk.Print_Operation.Gtk_Print_Operation. Since: gtk+ 2.18

Parameters
Self
Embed

True to embed page setup selection in the Gtk_Print_Unix_Dialog

Set_Export_Filename

procedure Set_Export_Filename
   (Self     : not null access Gtk_Print_Operation_Record;
    Filename : UTF8_String)

Sets up the Gtk.Print_Operation.Gtk_Print_Operation to generate a file instead of showing the print dialog. The indended use of this function is for implementing "Export to PDF" actions. Currently, PDF is the only supported format. "Print to PDF" support is independent of this and is done by letting the user pick the "Print to PDF" item from the list of printers in the print dialog. Since: gtk+ 2.10

Parameters
Self
Filename

the filename for the exported file

Set_Has_Selection

procedure Set_Has_Selection
   (Self          : not null access Gtk_Print_Operation_Record;
    Has_Selection : Boolean)

Sets whether there is a selection to print. Application has to set number of pages to which the selection will draw by Gtk.Print_Operation.Set_N_Pages in a callback of Gtk.Print_Operation.Gtk_Print_Operation::begin-print. Since: gtk+ 2.18

Parameters
Self
Has_Selection

True indicates that a selection exists

Set_Job_Name

procedure Set_Job_Name
   (Self     : not null access Gtk_Print_Operation_Record;
    Job_Name : UTF8_String)

Sets the name of the print job. The name is used to identify the job (e.g. in monitoring applications like eggcups). If you don't set a job name, GTK+ picks a default one by numbering successive print jobs. Since: gtk+ 2.10

Parameters
Self
Job_Name

a string that identifies the print job

Set_N_Pages

procedure Set_N_Pages
   (Self    : not null access Gtk_Print_Operation_Record;
    N_Pages : Glib.Gint)

Sets the number of pages in the document. This must be set to a positive number before the rendering starts. It may be set in a Gtk.Print_Operation.Gtk_Print_Operation::begin-print signal hander. Note that the page numbers passed to the Gtk.Print_Operation.Gtk_Print_Operation::request-page-setup and Gtk.Print_Operation.Gtk_Print_Operation::draw-page signals are 0-based, i.e. if the user chooses to print all pages, the last ::draw-page signal will be for page N_Pages - 1. Since: gtk+ 2.10

Parameters
Self
N_Pages

the number of pages

Set_Print_Settings

procedure Set_Print_Settings
   (Self           : not null access Gtk_Print_Operation_Record;
    Print_Settings : access Gtk.Print_Settings.Gtk_Print_Settings_Record'Class)

Sets the print settings for Op. This is typically used to re-establish print settings from a previous print operation, see Gtk.Print_Operation.Run. Since: gtk+ 2.10

Parameters
Self
Print_Settings

Gtk.Print_Settings.Gtk_Print_Settings

Set_Show_Progress

procedure Set_Show_Progress
   (Self          : not null access Gtk_Print_Operation_Record;
    Show_Progress : Boolean)

If Show_Progress is True, the print operation will show a progress dialog during the print operation. Since: gtk+ 2.10

Parameters
Self
Show_Progress

True to show a progress dialog

Set_Support_Selection

procedure Set_Support_Selection
   (Self              : not null access Gtk_Print_Operation_Record;
    Support_Selection : Boolean)

Sets whether selection is supported by Gtk.Print_Operation.Gtk_Print_Operation. Since: gtk+ 2.18

Parameters
Self
Support_Selection

True to support selection

Set_Track_Print_Status

procedure Set_Track_Print_Status
   (Self         : not null access Gtk_Print_Operation_Record;
    Track_Status : Boolean)

If track_status is True, the print operation will try to continue report on the status of the print job in the printer queues and printer. This can allow your application to show things like "out of paper" issues, and when the print job actually reaches the printer. This function is often implemented using some form of polling, so it should not be enabled unless needed. Since: gtk+ 2.10

Parameters
Self
Track_Status

True to track status after printing

Set_Unit

procedure Set_Unit
   (Self : not null access Gtk_Print_Operation_Record;
    Unit : Gtk.Enums.Gtk_Unit)

Sets up the transformation for the cairo context obtained from Gtk.Print_Context.Gtk_Print_Context in such a way that distances are measured in units of Unit. Since: gtk+ 2.10

Parameters
Self
Unit

the unit to use

Set_Use_Full_Page

procedure Set_Use_Full_Page
   (Self      : not null access Gtk_Print_Operation_Record;
    Full_Page : Boolean)

If Full_Page is True, the transformation for the cairo context obtained from Gtk.Print_Context.Gtk_Print_Context puts the origin at the top left corner of the page (which may not be the top left corner of the sheet, depending on page orientation and the number of pages per sheet). Otherwise, the origin is at the top left corner of the imageable area (i.e. inside the margins). Since: gtk+ 2.10

Parameters
Self
Full_Page

True to set up the Gtk.Print_Context.Gtk_Print_Context for the full page

Show_Progress_Property

Show_Progress_Property : constant Glib.Properties.Property_Boolean;

Determines whether to show a progress dialog during the print operation.

Signal_Begin_Print

Signal_Begin_Print : constant Glib.Signal_Name := "begin-print";

Emitted after the user has finished changing print settings in the dialog, before the actual rendering starts.

A typical use for ::begin-print is to use the parameters from the Gtk.Print_Context.Gtk_Print_Context and paginate the document accordingly, and then set the number of pages with Gtk.Print_Operation.Set_N_Pages.

Signal_Create_Custom_Widget

Signal_Create_Custom_Widget : constant Glib.Signal_Name := "create-custom-widget";

Emitted when displaying the print dialog. If you return a widget in a handler for this signal it will be added to a custom tab in the print dialog. You typically return a container widget with multiple widgets in it.

The print dialog owns the returned widget, and its lifetime is not controlled by the application. However, the widget is guaranteed to stay around until the Gtk.Print_Operation.Gtk_Print_Operation::custom-widget-apply signal is emitted on the operation. Then you can read out any information you need from the widgets.

Callback parameters:

Signal_Custom_Widget_Apply

Signal_Custom_Widget_Apply : constant Glib.Signal_Name := "custom-widget-apply";

Emitted right before Gtk.Print_Operation.Gtk_Print_Operation::begin-print if you added a custom widget in the Gtk.Print_Operation.Gtk_Print_Operation::create-custom-widget handler. When you get this signal you should read the information from the custom widgets, as the widgets are not guaraneed to be around at a later time.

Signal_Done

Signal_Done : constant Glib.Signal_Name := "done";

Emitted when the print operation run has finished doing everything required for printing.

Result gives you information about what happened during the run. If Result is Gtk.Print_Operation.Result_Error then you can call Gtk.Print_Operation.Get_Error for more information.

If you enabled print status tracking then Gtk.Print_Operation.Is_Finished may still return False after Gtk.Print_Operation.Gtk_Print_Operation::done was emitted.

Signal_Draw_Page

Signal_Draw_Page : constant Glib.Signal_Name := "draw-page";

Emitted for every page that is printed. The signal handler must render the Page_Nr's page onto the cairo context obtained from Context using Gtk.Print_Context.Get_Cairo_Context.

static void
draw_page (GtkPrintOperation *operation,
           GtkPrintContext   *context,
           gint               page_nr,
           gpointer           user_data)
{
  cairo_t *cr;
  PangoLayout *layout;
  gdouble width, text_height;
  gint layout_height;
  PangoFontDescription *desc;

  cr = gtk_print_context_get_cairo_context (context);
  width = gtk_print_context_get_width (context);

  cairo_rectangle (cr, 0, 0, width, HEADER_HEIGHT);

  cairo_set_source_rgb (cr, 0.8, 0.8, 0.8);
  cairo_fill (cr);

  layout = gtk_print_context_create_pango_layout (context);

  desc = pango_font_description_from_string ("sans 14");
  pango_layout_set_font_description (layout, desc);
  pango_font_description_free (desc);

  pango_layout_set_text (layout, "some text", -1);
  pango_layout_set_width (layout, width * PANGO_SCALE);
  pango_layout_set_alignment (layout, PANGO_ALIGN_CENTER);

  pango_layout_get_size (layout, NULL, &layout_height);
  text_height = (gdouble)layout_height / PANGO_SCALE;

  cairo_move_to (cr, width / 2,  (HEADER_HEIGHT - text_height) / 2);
  pango_cairo_show_layout (cr, layout);

  g_object_unref (layout);
}

Use Gtk.Print_Operation.Set_Use_Full_Page and Gtk.Print_Operation.Set_Unit before starting the print operation to set up the transformation of the cairo context according to your needs.

Callback parameters: -- @param Context the Gtk.Print_Context.Gtk_Print_Context for the current -- operation -- @param Page_Nr the number of the currently printed page (0-based)

Signal_End_Print

Signal_End_Print : constant Glib.Signal_Name := "end-print";

Emitted after all pages have been rendered. A handler for this signal can clean up any resources that have been allocated in the Gtk.Print_Operation.Gtk_Print_Operation::begin-print handler.

Signal_Paginate

Signal_Paginate : constant Glib.Signal_Name := "paginate";

Emitted after the Gtk.Print_Operation.Gtk_Print_Operation::begin-print signal, but before the actual rendering starts. It keeps getting emitted until a connected signal handler returns True.

The ::paginate signal is intended to be used for paginating a document in small chunks, to avoid blocking the user interface for a long time. The signal handler should update the number of pages using Gtk.Print_Operation.Set_N_Pages, and return True if the document has been completely paginated.

If you don't need to do pagination in chunks, you can simply do it all in the ::begin-print handler, and set the number of pages from there.

Callback parameters: -- @param Context the Gtk.Print_Context.Gtk_Print_Context for the current -- operation

Signal_Preview

Signal_Preview : constant Glib.Signal_Name := "preview";

Gets emitted when a preview is requested from the native dialog.

The default handler for this signal uses an external viewer application to preview.

To implement a custom print preview, an application must return True from its handler for this signal. In order to use the provided Context for the preview implementation, it must be given a suitable cairo context with Gtk.Print_Context.Set_Cairo_Context.

The custom preview implementation can use Gtk.Print_Operation_Preview.Is_Selected and Gtk.Print_Operation_Preview.Render_Page to find pages which are selected for print and render them. The preview must be finished by calling Gtk.Print_Operation_Preview.End_Preview (typically in response to the user clicking a close button).

Callback parameters: -- @param Preview the -- Gtk.Print_Operation_Preview.Gtk_Print_Operation_Preview for the current -- operation -- @param Context the Gtk.Print_Context.Gtk_Print_Context that will be -- used -- @param Parent the Gtk.Window.Gtk_Window to use as window parent, or -- null

Signal_Request_Page_Setup

Signal_Request_Page_Setup : constant Glib.Signal_Name := "request-page-setup";

Emitted once for every page that is printed, to give the application a chance to modify the page setup. Any changes done to Setup will be in force only for printing this page.

Callback parameters: -- @param Context the Gtk.Print_Context.Gtk_Print_Context for the current -- operation -- @param Page_Nr the number of the currently printed page (0-based) -- @param Setup the Gtk.Page_Setup.Gtk_Page_Setup

Signal_Status_Changed

Signal_Status_Changed : constant Glib.Signal_Name := "status-changed";

Emitted at between the various phases of the print operation. See Gtk.Print_Operation.Gtk_Print_Status for the phases that are being discriminated. Use Gtk.Print_Operation.Get_Status to find out the current status.

Signal_Update_Custom_Widget

Signal_Update_Custom_Widget : constant Glib.Signal_Name := "update-custom-widget";

Emitted after change of selected printer. The actual page setup and print settings are passed to the custom widget, which can actualize itself according to this change.

Callback parameters: -- @param Widget the custom widget added in create-custom-widget -- @param Setup actual page setup -- @param Settings actual print settings

Status_Property

Status_Property : constant Gtk.Print_Operation.Property_Gtk_Print_Status;

Type: Gtk_Print_Status The status of the print operation.

Status_String_Property

Status_String_Property : constant Glib.Properties.Property_String;

A string representation of the status of the print operation. The string is translated and suitable for displaying the print status e.g. in a Gtk.Status_Bar.Gtk_Status_Bar.

See the Gtk.Print_Operation.Gtk_Print_Operation:status property for a status value that is suitable for programmatic use.

Support_Selection_Property

Support_Selection_Property : constant Glib.Properties.Property_Boolean;

If True, the print operation will support print of selection. This allows the print dialog to show a "Selection" button.

Track_Print_Status_Property

Track_Print_Status_Property : constant Glib.Properties.Property_Boolean;

If True, the print operation will try to continue report on the status of the print job in the printer queues and printer. This can allow your application to show things like "out of paper" issues, and when the print job actually reaches the printer. However, this is often implemented using polling, and should not be enabled unless needed.

Unit_Property

Unit_Property : constant Gtk.Enums.Property_Gtk_Unit;

The transformation for the cairo context obtained from Gtk.Print_Context.Gtk_Print_Context is set up in such a way that distances are measured in units of Unit.

Use_Full_Page_Property

Use_Full_Page_Property : constant Glib.Properties.Property_Boolean;

If True, the transformation for the cairo context obtained from Gtk.Print_Context.Gtk_Print_Context puts the origin at the top left corner of the page (which may not be the top left corner of the sheet, depending on page orientation and the number of pages per sheet). Otherwise, the origin is at the top left corner of the imageable area (i.e. inside the margins).

Simple Types

Tagged Types

Access Types

Constants

Subprograms

Generic Instantiations